Spring Boot项目快速创建-开发流程（笔记）

紧张流程：
  前端发送网络哀求->controller->调用service->利用mapper->操作数据库->对entity数据对象赋值->返回前端
    前期预备：
  maven、mysql下载好 
    跟学视频，感谢老师： https://www.bilibili.com/video/BV1gm411m7i6/?share_source=copy_web&vd_source=92d754038ee61d01dacfbb2bacae8320
  打点：
  00:00 - 42:53 GET接口
  42:54 - 51:24 POST接口
  51:25 - 54:20 DELETE接口
  54:21 - 1:02:11 UPDATE接口
  1:02:17 - 1:04:22 打包 
  一、项目创建 

初始化Spring boot应用：Spring Initializr
配置好以下内容（根据实际环境选择java版本） ，点GENERATE天生项目。

解压项目之后，idea打开open，导入项目标pom.xml文件。

 

项目结构，源代码全部放在JAVA文件夹下

因为还没有数据库，以是先把pom.xml里数据库的部分注释掉（否则会报错）

然后革新一下maven，手动reload一下

接下来实验运行，打开java文件，点击三角，运行main方法

 

可以望见运行起来

右键创建一个测试的controller，编写代码然后运行。

 

1. package com.example.demo;
3. import org.springframework.web.bind.annotation.GetMapping;
4. import org.springframework.web.bind.annotation.RestController;
6. @RestController
7. public class TestController {
8.     @GetMapping ("/hello")
9.     public String hello() {
10.         return "Hello World";
11.     }
12. }

复制代码

运行后，浏览器访问localhost:8080/hello

   ​基本概念
  

• **@Controller**：标记类为 Spring MVC 控制器，处置处罚 HTTP 哀求并返回视图（如 HTML）。
  
• ​**@ResponseBody**：将方法的返回值直接写入 HTTP 响体中，而非渲染视图。
  
• ​**@RestController** = @Controller + @ResponseBody，​专用于 RESTful API，自动将返回对象转为 JSON/XML 格式。
  

  焦点功能
  

• 通过 @RequestMapping、@GetMapping、@PostMapping 等注解绑定 URL 路径。
  

  改为List： 

1. package com.example.demo;
3. import org.springframework.web.bind.annotation.GetMapping;
4. import org.springframework.web.bind.annotation.RestController;
6. import java.util.List;
8. @RestController
9. public class TestController {
10.     @GetMapping ("/hello")
11.     public List<String> hello() {
12.         return List.of("Hello","World");
13.     }
14. }

复制代码

显示JSON格式 ：

 

 二、rest api规范

   8个HTTP方法：
  GET
POST
PUT
DELETE
OPTIONS
HEAD
TRACE
CONNECT
  1.创建数据库 

启动数据库：net start mysql
登录数据库：mysql -uroot -p1234（-u和-p后写本身的用户名和密码）

1. //创建数据库
2. create database test
3.         character set utf8mb4
4.         collate utf8mb4_general_ci
6. //选中该数据库
7. use test;
9. //创建数据表
10. create table student(
11.         id int auto_increment primary key,
12.         name varchar(50) not null,
13.         phone char(11) not null,
14.         age int
15. );
18. //插入一条数据
19. insert into student (name,phone,age)
20. values('TOM','12345678910',30);

复制代码

2.写实际代码

①GET接口

规复上面注释的依靠

新建对应的package，在package里新建接口StudentRepository：

 

再建一个学生类： 

1. //Student.java
2. package com.example.demo.dao;
4. import jakarta.persistence.*;
6. @Entity
7. @Table(name="student")
8. public class Student {
10.     @Id
11.     @Column(name = "id")
12.     @GeneratedValue(strategy = GenerationType.IDENTITY)
13.     private long id;
15.     @Column(name = "name")
16.     private String name;
18.     @Column(name = "phone")
19.     private String phone;
21.     @Column(name = "age")
22.     private int age;
24.     public long getId() {
25.         return id;
26.     }
28.     public void setId(long id) {
29.         this.id = id;
30.     }
32.     public String getName() {
33.         return name;
34.     }
36.     public void setName(String name) {
37.         this.name = name;
38.     }
40.     public String getPhone() {
41.         return phone;
42.     }
44.     public void setPhone(String phone) {
45.         this.phone = phone;
46.     }
48.     public int getAge() {
49.         return age;
50.     }
52.     public void setAge(int age) {
53.         this.age = age;
54.     }
55. }

复制代码

1. //StudentRepository.java
2. package com.example.demo.dao;
4. import org.springframework.data.jpa.repository.JpaRepository;
5. import org.springframework.stereotype.Repository;
7. @Repository
8. public interface StudentRepository extends JpaRepository<Student,Long> {
10. }

复制代码

然后再创建一个package，写service层，同样新建一个接口文件StudentService，以及对应的一个实现StudentServiceImpl
现在目录是这个格式：

1. //StudentServiceImpl.java
2. package com.example.demo.service;
4. import com.example.demo.dao.Student;
5. import com.example.demo.dao.StudentRepository;
6. import org.springframework.beans.factory.annotation.Autowired;
7. import org.springframework.stereotype.Service;
9. @Service
10. public class StudentServiceImpl implements StudentService {
11.    
12.     @Autowired
13.     private StudentRepository studentRepository;
14.    
15.     @Override
16.     public Student getStudentById(long id) {
17.         return studentRepository.findById(id).orElseThrow(RuntimeException::new);
18.     }
19. }

复制代码

1. //StudentService.java
2. package com.example.demo.service;
4. import com.example.demo.dao.Student;
6. public interface StudentService {
7.     public Student getStudentById(long id);
9. }

复制代码

接下来写对应的api层controller的代码，新建package名为controller，包里建StudentController类。

1. package com.example.demo.controller;
3. import com.example.demo.dao.Student;
4. import com.example.demo.service.StudentService;
5. import org.springframework.beans.factory.annotation.Autowired;
6. import org.springframework.web.bind.annotation.GetMapping;
7. import org.springframework.web.bind.annotation.PathVariable;
8. import org.springframework.web.bind.annotation.RestController;
10. @RestController
11. public class StudentController {
13.     @Autowired
14.     private StudentService studentService;
16.     @GetMapping("/student/{id}")
17.     public Student getStudent(@PathVariable long id) {
18.         return studentService.getStudentById(id);
19.     }
20. }

复制代码

配置数据库url（用户名和密码写本身的）：

1. spring.datasource.url=jdbc:mysql://localhost:3306/test?characterEncoding=utf-8
2. spring.datasource.username=root
3. spring.datasource.password=1234

复制代码

在浏览器中输入  localhost:8080/student/1
返回信息： 
 

---

因为controller直接返回了这些值不敷规范，有些加密字段是不想展示给前端的，比如这里将年事保密，不显示。
以是新建一个dto的package以及StudentDTO对象，用来展示可以给前端的数据。

1. package com.example.demo.dto;
3. public class StudentDTO {
4.     private long id;
5.     private String name;
6.     private String phone;
8.     public long getId() {
9.         return id;
10.     }
12.     public void setId(long id) {
13.         this.id = id;
14.     }
16.     public String getName() {
17.         return name;
18.     }
20.     public void setName(String name) {
21.         this.name = name;
22.     }
24.     public String getPhone() {
25.         return phone;
26.     }
28.     public void setPhone(String phone) {
29.         this.phone = phone;
30.     }
31. }

复制代码

修改controller层和service层 ：

1. package com.example.demo.controller;
3. import com.example.demo.Response;
4. import com.example.demo.dao.Student;
5. import com.example.demo.dto.StudentDTO;
6. import com.example.demo.service.StudentService;
7. import org.springframework.beans.factory.annotation.Autowired;
8. import org.springframework.web.bind.annotation.GetMapping;
9. import org.springframework.web.bind.annotation.PathVariable;
10. import org.springframework.web.bind.annotation.RestController;
12. @RestController
13. public class StudentController {
15.     @Autowired
16.     private StudentService studentService;
18.     @GetMapping("/student/{id}")
19.     public Response<StudentDTO> getStudent(@PathVariable long id) {
20.         return Response.newSuccess(studentService.getStudentById(id));
21.     }
22. }

复制代码

1. package com.example.demo.service;
3. import com.example.demo.dao.Student;
4. import com.example.demo.dto.StudentDTO;
6. public interface StudentService {
7.     StudentDTO getStudentById(long id);
8. }

复制代码

1. package com.example.demo.service;
3. import com.example.demo.converter.StudentConverter;
4. import com.example.demo.dao.Student;
5. import com.example.demo.dao.StudentRepository;
6. import com.example.demo.dto.StudentDTO;
7. import org.springframework.beans.factory.annotation.Autowired;
8. import org.springframework.stereotype.Service;
10. @Service
11. public class StudentServiceImpl implements StudentService {
13.     @Autowired
14.     private StudentRepository studentRepository;
16.     @Override
17.     public StudentDTO getStudentById(long id) {
18.         Student student= studentRepository.findById(id).orElseThrow(RuntimeException::new);
19.          return StudentConverter.convertStudent(student);
20.     }
21. }

复制代码

新建package和类：

1. package com.example.demo.converter;
3. import com.example.demo.dao.Student;
4. import com.example.demo.dto.StudentDTO;
6. public class StudentConverter {
7.     public static StudentDTO convertStudent(Student student) {
8.         StudentDTO studentDTO = new StudentDTO();
9.         studentDTO.setId(student.getId());
10.         studentDTO.setName(student.getName());
11.         studentDTO.setPhone(student.getPhone());
12.         return studentDTO;
13.     }
14. }

复制代码

新建一个Response类，统逐一些后端访问的格式：

1. package com.example.demo;
3. public class Response <T>{
4.     private T data;
5.     private boolean success;
6.     private String errorMsg;
8.     public static <K> Response<K> newSuccess(K data) {
9.         Response<K> response = new Response<>();
10.         response.setData(data);
11.         response.setSuccess(true);
12.         return response;
13.     }
15.     public static Response<Void> newFail(String errorMsg) {
16.         Response<Void> response = new Response<>();
17.         response.setErrorMsg(errorMsg);
18.         response.setSuccess(false);
19.         return response;
20.     }
22.     public T getData() {
23.         return data;
24.     }
26.     public void setData(T data) {
27.         this.data = data;
28.     }
30.     public boolean isSuccess() {
31.         return success;
32.     }
34.     public void setSuccess(boolean success) {
35.         this.success = success;
36.     }
38.     public String getErrorMsg() {
39.         return errorMsg;
40.     }
42.     public void setErrorMsg(String errorMsg) {
43.         this.errorMsg = errorMsg;
44.     }
45. }

复制代码

 把代码都修改完之后启动，可以望见age隐藏了没有显示。返回成功。
 

以上是完备的GET查询接口的实现，用来查询id=1的学生信息。

---

②POST接口

接下来新增一个POST接口，用来新增学生信息。
目标：将前端传来的json文件转为Java对象存储至数据库。因为传过来的DTO，以是须要converter，之以是返回getbyid，因为这个方法返回是Long。
编写代码，在原有文件上新增就行，以下复制完备的：

1. package com.example.demo.controller;
3. import com.example.demo.Response;
4. import com.example.demo.dao.Student;
5. import com.example.demo.dto.StudentDTO;
6. import com.example.demo.service.StudentService;
7. import org.springframework.beans.factory.annotation.Autowired;
8. import org.springframework.web.bind.annotation.*;
10. @RestController
11. public class StudentController {
13.     @Autowired
14.     private StudentService studentService;
16.     @GetMapping("/student/{id}")
17.     public Response<StudentDTO> getStudent(@PathVariable long id) {
18.         return Response.newSuccess(studentService.getStudentById(id));
19.     }
21.     @RequestMapping("/student")
22.     @PostMapping("/student")
23.     public Response<Long> addNewStudent(@RequestParam StudentDTO studentDTO) {
24.         return Response.newSuccess(studentService.addNewStudent(studentDTO));
26.     }
27. }

复制代码

1. package com.example.demo.service;
3. import com.example.demo.dao.Student;
4. import com.example.demo.dto.StudentDTO;
6. public interface StudentService {
7.     StudentDTO getStudentById(long id);
8.    
9.     Long addNewStudent(StudentDTO studentDTO);
10. }

复制代码

1. package com.example.demo.service;
3. import com.example.demo.converter.StudentConverter;
4. import com.example.demo.dao.Student;
5. import com.example.demo.dao.StudentRepository;
6. import com.example.demo.dto.StudentDTO;
7. import org.springframework.beans.factory.annotation.Autowired;
8. import org.springframework.stereotype.Service;
9. import org.springframework.util.CollectionUtils;
11. import java.util.List;
13. @Service
14. public class StudentServiceImpl implements StudentService {
16.     @Autowired
17.     private StudentRepository studentRepository;
19.     @Override
20.     public StudentDTO getStudentById(long id) {
21.         Student student= studentRepository.findById(id).orElseThrow(RuntimeException::new);
22.         return StudentConverter.convertStudent(student);
23.     }
25.     @Override
26.     public Long addNewStudent(StudentDTO studentDTO) {
27.         List<Student> studentList=studentRepository.findByPhone(studentDTO.getPhone());
28.         if (!CollectionUtils.isEmpty(studentList)){
29.             throw new IllegalStateException("phone:"+studentDTO.getPhone()+" has been taken");
30.         }
31.         Student student=studentRepository.save(StudentConverter.convertStudent(studentDTO));
32.         return student.getId();
33.     }
34. }

复制代码

1. package com.example.demo.converter;
3. import com.example.demo.dao.Student;
4. import com.example.demo.dto.StudentDTO;
6. public class StudentConverter {
7.     public static StudentDTO convertStudent(Student student) {
8.         StudentDTO studentDTO = new StudentDTO();
9.         studentDTO.setId(student.getId());
10.         studentDTO.setName(student.getName());
11.         studentDTO.setPhone(student.getPhone());
12.         return studentDTO;
13.     }
15.     public static Student convertStudent(StudentDTO studentDTO) {
16.         Student student = new Student();
17.         student.setName(studentDTO.getName());
18.         student.setPhone(studentDTO.getPhone());
19.         return student;
20.     }
21. }

复制代码

1. package com.example.demo.dao;
3. import org.springframework.data.jpa.repository.JpaRepository;
4. import org.springframework.stereotype.Repository;
6. import java.util.List;
8. @Repository
9. public interface StudentRepository extends JpaRepository<Student,Long> {
11.     List<Student> findByPhone(String phone);
12. }

复制代码

 修改完代码就可以使用Postman工具新增学生信息（没有下载以是跳过这步了）

---

③DELETE接口

接下来实现DELETE删除接口。
在原有文件新增就行，新增代码如下：

1. //StudentController
2.     @DeleteMapping("/student/{id}")
3.     public void deleteStudentById(@PathVariable long id) {
4.         studentService.deleteStudentById(id);
5.     }
8. //StudentService
9. void deleteStudentById(long id);
12. //StudentServiceImpl
13. @Override
14.     public void deleteStudentById(long id) {
15.         studentRepository.findById(id).orElseThrow(() -> new IllegalArgumentException("id:"+ id +"doesn't exist!"));
16.         studentRepository.deleteById(id);
17.     }

复制代码

接下来也是使用postman来删除和查询。（没下载以是又跳过这步，之后如果下载了再来补） 

---

④UPDATE接口

接下来实现UPDATE接口。
在原有文件新增代码如下：

1. //StudentController
2.      @PutMapping("/student/{id}")
3.     public Response<StudentDTO> updateStudentById(@PathVariable long id, @RequestParam (required = false)String name,
4.                                               @RequestParam(required = false)String phone) {
5.         return Response.newSuccess(studentService.updataStudentById(id,name,phone));
6.     }
9. //StudentService
10. StudentDTO updataStudentById(long id, String name, String phone);
13. //StudentServiceImpl
14. @Override
15.     @Transactional
16.     public StudentDTO updataStudentById(long id, String name, String phone) {
17.         Student studentInDB=studentRepository.findById(id).orElseThrow(() -> new IllegalArgumentException("id:"+ id +"doesn't exist!"));
18.         if(StringUtils.hasLength(name) && !studentInDB.getName().equals(name)){
19.             studentInDB.setName(name);
20.         }
21.         if(StringUtils.hasLength(phone) && !studentInDB.getPhone().equals(phone)){
22.             studentInDB.setPhone(phone);
23.         }
24.         Student student=studentRepository.save(studentInDB);
25.         return StudentConverter.convertStudent(student);
26.     }

复制代码

接下来也是使用postman来更新和查询。
三、打包项目 

使用下令：mvn clean install 
 

但是出现错误：

错误信息：

1. [ERROR] Failed to execute goal org.apache.maven.plugins:maven-clean-plugin:3.4.1:clean (default-clean) on project demo: The plugin org.apache.maven.plugins:maven-clean-plugin:3.4.1 requires Maven version 3.6.3 -> [Help 1]
2. [ERROR]
3. [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
4. [ERROR] Re-run Maven using the -X switch to enable full debug logging.
5. [ERROR]
6. [ERROR] For more information about the errors and possible solutions, please read the following articles:
7. [ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/PluginIncompatibleException

复制代码

缘故原由是当前maven版本为3.6.1，但项目依靠 Spring Boot 3.4.4，官方要求 ​Maven 3.8.8+ 或 ​Java 21+。
重新下载更高级的maven版本：Welcome to Apache Maven – Maven
下载教程：Maven下载以及项目创建（笔记）_maven 依靠 如何下载 com.github-CSDN博客
须要注意！重新配置maven环境变量时，最好删除原来的MAVEN_HOME，重新添加，否则不会更新。 
IDEA重新配置maven路径，重启：

可以看到已经将版本更新了 

使用下令：mvn clean install ，成功啦！！

复制一下jar包路径
 

可以用java -jar demo-0.0.1-SNAPSHOT.jar来启动项目： 

 

---

以上，总结：

---

完结撒花，零基础，耗时7小时。


免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。