使用 Spring Boot 2、JPA、Hibernate 和 MySQL创建CRUD REST API服务

た入场券 2023-10-04 15:03 52阅读 0赞

2019 年 8 月 31 日

[布佩什·辛格·帕迪亚尔][Link 1]

![e377f6c1cc85ab5878f49e0b3b6a5925.png][]

### **＃介绍：** ###

在这篇文章中，我将使用 Spring Boot 设置 REST API 项目，这将使用 mysql 数据库和 Spring Data 作为持久性 API。

在这里，我将创建一个 Spring Boot REST CRUD 应用程序，它提供用于创建用户、读取用户、更新用户和删除用户的 REST API。

### **\#先决条件：** ###

在开始之前，请确保您拥有以下开发环境。

1.  **JDK 1.8**或以上
2.  **MySQL** 5.xxx
3.  **Apache Maven** 3.xxx
4.  **IDE - STS**（首选 Spring Tool Suite）

### **\#应用结构：** ###

--------------------

此应用程序涉及四个主要实体

1.  **数据库 -**用于存储和检索数据的 MySQL 数据库。
2.  **RestController 层 -**控制请求和响应。
3.  **存储库层 -**从数据库中存储和检索数据。
4.  **客户端 -**要访问 API 资源的客户端。

![932116bb00f162b53ee5c880a5790062.png][]

### **\#创建应用程序的步骤** ###

--------------------

有以下3种方式来初始化spring boot项目

*  使用 Spring Boot CLI 工具
 *  使用 STS IDE
 *  使用 Spring Initializr（**网站** [http://start.spring.io/][http_start.spring.io]）

我们将在这里使用第二种方法（STS IDE）

以下是创建应用程序的步骤

### **\#Step 1：** **初始化spring boot项目并导入STS IDE** ###

--------------------

1.  **Web** — 使用 Tomcat 和 Spring MVC 的全栈 Web 开发。
2.  **DevTools** — Spring Boot 开发工具
3.  **JPA** — Java 持久性 API，包括 spring-data-JPA、spring-orm 和 Hibernate
4.  **MySQL** — MySQL JDBC 驱动程序
5.  **Actuator** — 生产就绪功能，可帮助您监控和管理您的应用程序

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 1][]

生成、下载项目并将其导入 Spring Tool Suite (STS) IDE。以下是最终的项目结构。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 2][]

### **\#Step 2：** **在 MySQL 中创建数据库和表** ###

--------------------

创建数据库**users\_db** & **users**表

CREATE SCHEMA `users_db` ;

CREATE TABLE `users` (
          `id` int(11) NOT NULL AUTO_INCREMENT,
          `user_email` varchar(100) NOT NULL,
          `first_name` varchar(45) NOT NULL,
          `last_name` varchar(45) NOT NULL,
          `age` int(3) NOT NULL,
          `created_on` datetime DEFAULT NULL,
          `updated_on` datetime DEFAULT NULL,
          PRIMARY KEY (`id`)
        ) ENGINE=InnoDB AUTO_INCREMENT=1;

### **\#Step 3：** **配置application.properties** ###

--------------------

在 application.properties 文件中配置您的 MySQL 数据库详细信息，即数据库 URL、db 用户名、db 密码和应用程序端口。

## Server Port
    server.port= 8888
    
    ## Mysql Database Properties
    spring.datasource.url = jdbc:mysql://localhost:3306/users_db?autoReconnect=true&useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
    spring.datasource.username = root
    spring.datasource.password = root
    
    ## Hibernate Properties
    # The SQL dialect makes Hibernate generate better SQL for the chosen database
    spring.jpa.properties.hibernate.dialect = org.hibernate.dialect.MySQL5InnoDBDialect
    
    # Hibernate ddl auto (create, create-drop, validate, update)
    spring.jpa.hibernate.ddl-auto = update

### **\#Step 4：** **创建实体类** ###

--------------------

创建一个实体类**User.java**来保存从数据库中检索到的用户详细信息，并将用户表字段与该实体映射

**User.java**

package com.example.demo.models;
    
    import java.util.Date;
    
    import javax.persistence.Column;
    import javax.persistence.Entity;
    import javax.persistence.EntityListeners;
    import javax.persistence.GeneratedValue;
    import javax.persistence.GenerationType;
    import javax.persistence.Id;
    import javax.persistence.Table;
    
    import org.hibernate.annotations.CreationTimestamp;
    import org.hibernate.annotations.UpdateTimestamp;
    import org.springframework.data.jpa.domain.support.AuditingEntityListener;
    
    
    
    @Entity
    @Table(name = "users")
    @EntityListeners(AuditingEntityListener.class)
    public class User {
    
    	@Id
    	@GeneratedValue(strategy = GenerationType.AUTO)
    	private long id;
    	
    	@Column(name = "user_email", nullable = false)
    	private String email;
    	
    	@Column(name = "first_name", nullable = false)
    	private String firstName;
    
    	@Column(name = "last_name", nullable = false)
    	private String lastName;
    
    	@Column(name = "age", nullable = false)
    	private int age;
    
    	@Column(name = "created_on", nullable = false)
    	@CreationTimestamp
    	private Date createdOn;
    
    	@Column(name = "updated_on", nullable = false)
    	@UpdateTimestamp
    	private Date updatedOn;
    
    
    	public long getId() {
    		return id;
    	}
    
    	public void setId(long id) {
    		this.id = id;
    	}
    
    	public String getEmail() {
    		return email;
    	}
    
    	public void setEmail(String email) {
    		this.email = email;
    	}
    
    	public String getFirstName() {
    		return firstName;
    	}
    
    	public void setFirstName(String firstName) {
    		this.firstName = firstName;
    	}
    
    	public String getLastName() {
    		return lastName;
    	}
    
    	public void setLastName(String lastName) {
    		this.lastName = lastName;
    	}
    
    	public int getAge() {
    		return age;
    	}
    
    	public void setAge(int age) {
    		this.age = age;
    	}
    
    	public Date getCreatedOn() {
    		return createdOn;
    	}
    
    	public void setCreatedOn(Date createdOn) {
    		this.createdOn = createdOn;
    	}
    
    	public Date getUpdatedOn() {
    		return updatedOn;
    	}
    
    	public void setUpdatedOn(Date updatedOn) {
    		this.updatedOn = updatedOn;
    	}
    
    }

### **\#Step 5：** **创建 JPA 数据存储库层** ###

--------------------

**Spring Data**包括对 MySQL 的存储库支持。与 JPA 存储库一样，基本原则是根据方法名称自动为您构造查询。基本上，这一层实现了常见的 DAO 操作，即保存、更新、删除、列出数据等。我们可以编写自定义查询和本机 SQL 查询。

Spring Data JPA 提供了三个接口`CrudRepository`，`PagingAndSortingRepository` 以及`JpaRepository.`

我们将在其他文章中详细讨论这些接口。

我们将`JpaRepository` 在这个项目中使用这里。

**UserRepository.java**

package com.example.demo.repositories;
    
    import org.springframework.data.jpa.repository.JpaRepository;
    import org.springframework.stereotype.Repository;
    
    import com.example.demo.models.User;
    
    
    
    @Repository
    public interface UserRepository extends JpaRepository<User, Long> {
    
    }

### **\#Step 6：** **管理异常和错误处理** ###

--------------------

为了处理异常和错误，这里我们将为控制器层编写一个全局异常处理程序，它将处理从控制器抛出的所有运行时异常。这个 GlobalExceptionHandler 也可以处理自定义异常。我们需要在这里提及所有例外情况。

在这里，我们将定义一个自定义异常 UserNotFoundException 来处理如果在 DB 中找不到用户。

**UserNotFoundException.java**

package com.example.demo.exceptions;
    
    import org.springframework.http.HttpStatus;
    import org.springframework.web.bind.annotation.ResponseStatus;
    
    
    
    @ResponseStatus(value = HttpStatus.NOT_FOUND)
    public class UserNotFoundException extends Exception {
    
    	  /**
    	   * Instantiates a new User not found exception.
    	   *
    	   * @param message the message
    	   */
    	  public UserNotFoundException(String message) {
    	    super(message);
    	  }
    }

**全局异常处理程序**

package com.example.demo.exceptions;
    
    import java.util.Date;
    
    import org.springframework.http.HttpStatus;
    import org.springframework.http.ResponseEntity;
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.context.request.WebRequest;
    
    
    
    @ControllerAdvice
    public class GlobalExceptionHandler {
    
      /**
       * Resource not found exception response entity.
       *
       * @param ex the ex
       * @param request the request
       * @return the response entity
       */
      @ExceptionHandler(UserNotFoundException.class)
      public ResponseEntity<?> UserNotFoundException(
          UserNotFoundException ex, WebRequest request) {
        ErrorResponse errorDetails =
            new ErrorResponse(new Date(), HttpStatus.NOT_FOUND.toString(), ex.getMessage(), request.getDescription(false));
        return new ResponseEntity<>(errorDetails, HttpStatus.NOT_FOUND);
      }
    
      /**
       * Globle excpetion handler response entity.
       *
       * @param ex the ex
       * @param request the request
       * @return the response entity
       */
      @ExceptionHandler(Exception.class)
      public ResponseEntity<?> globleExcpetionHandler(Exception ex, WebRequest request) {
        ErrorResponse errorDetails =
            new ErrorResponse(new Date(), HttpStatus.INTERNAL_SERVER_ERROR.toString() ,ex.getMessage(), request.getDescription(false));
        return new ResponseEntity<>(errorDetails, HttpStatus.INTERNAL_SERVER_ERROR);
      }
    }

### **\#Step 7：** **创建Rest Controller并映射所有API端点** ###

--------------------

创建类 UserController.java，定义所有 API 映射。

**UserController.java**

package com.example.demo.controller;
    
    import java.util.Date;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    
    import javax.validation.Valid;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.http.ResponseEntity;
    import org.springframework.web.bind.annotation.DeleteMapping;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.PutMapping;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import com.example.demo.exceptions.UserNotFoundException;
    import com.example.demo.models.User;
    import com.example.demo.repositories.UserRepository;
    
    /**
     * @author Bhupesh Singh Padiyar
     *
     */
    
    @RestController
    @RequestMapping("/api")
    public class UserController {
    	
    	  @Autowired
    	  private UserRepository userRepository;
    	  /**
    	   * Get all users list.
    	   *
    	   * @return the list
    	   */
    	  @GetMapping("/users")
    	  public List<User> getAllUsers() {
    	    return userRepository.findAll();
    	  }
    	  /**
    	   * Gets users by id.
    	   *
    	   * @param userId the user id
    	   * @return the users by id
    	   * @throws UserNotFoundException the user not found exception
    	   */
    	  @GetMapping("/users/{id}")
    	  public ResponseEntity<User> getUsersById(@PathVariable(value = "id") Long userId)
    	      throws UserNotFoundException {
    	    User user =
    	        userRepository
    	            .findById(userId)
    	            .orElseThrow(() -> new UserNotFoundException("User not found on :: " + userId));
    	    return ResponseEntity.ok().body(user);
    	  }
    	  /**
    	   * Create user user.
    	   *
    	   * @param user the user
    	   * @return the user
    	   */
    	  @PostMapping("/user")
    	  public User createUser(@Valid @RequestBody User user) {
    		
    	    return userRepository.save(user);
    	  }
    	  /**
    	   * Update user response entity.
    	   *
    	   * @param userId the user id
    	   * @param userDetails the user details
    	   * @return the response entity
    	   * @throws UserNotFoundException the user not found exception
    	   */
    	  @PutMapping("/user/{id}")
    	  public ResponseEntity<User> updateUser(
    	      @PathVariable(value = "id") Long userId, @Valid @RequestBody User userDetails)
    	      throws UserNotFoundException {
    		  User user =
    	        userRepository
    	            .findById(userId)
    	            .orElseThrow(() -> new UserNotFoundException("User not found on :: " + userId));
    	    user.setEmail(userDetails.getEmail());
    	    user.setLastName(userDetails.getLastName());
    	    user.setFirstName(userDetails.getFirstName());
    	    user.setUpdatedOn(new Date());
    	    final User updatedUser = userRepository.save(user);
    	    return ResponseEntity.ok(updatedUser);
    	  }
    	  /**
    	   * Delete user map.
    	   *
    	   * @param userId the user id
    	   * @return the map
    	   * @throws Exception the exception
    	   */
    	  @DeleteMapping("/user/{id}")
    	  public Map<String, Boolean> deleteUser(@PathVariable(value = "id") Long userId) throws Exception {
    		  User user =
    	        userRepository
    	            .findById(userId)
    	            .orElseThrow(() -> new UserNotFoundException("User not found on :: " + userId));
    	    userRepository.delete(user);
    	    Map<String, Boolean> response = new HashMap<>();
    	    response.put("deleted", Boolean.TRUE);
    	    return response;
    	  }
    }

### **\#Step 8：** **构建**并**运行应用程序** ###

--------------------

转到终端/命令提示符和下面命令中的项目位置以构建应用程序。它将在**目标**目录中创建应用程序 .jar 文件。

mvn clean compile install

要运行 Java 应用程序，请使用以下命令

java -jar target/spring-boot-mysql-rest-0.0.1-SNAPSHOT.jar

或者，您可以不打包运行应用程序，如下所示

mvn spring-boot:run

应用程序将在**http://localhost:8888**开始运行

### **\#测试REST端点** ###

--------------------

成功运行应用程序后，现在我们将测试所有的创建、检索、更新、删除资源。有多种工具、应用程序和 chrome 插件可用于测试**REST**服务。

我在这里使用**POSTMAN**工具进行测试。

### **\#创建用户服务：** ###

--------------------

创建用户是一个**POST**类型的服务。以下是服务 URL、语法和**POSTMAN**截图。

服务地址：http://localhost:8888/api/user

请求类型：POST

POSTMAN 请求截图

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 3][]

### **\#更新用户服务：** ###

--------------------

Create User 是一个**PUT**类型的服务。以下是服务 URL、语法和**POSTMAN**截图。

服务网址：http://localhost:8888/api/user/\{id\}

请求类型：PUT

POSTMAN 请求截图

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 4][]

### **\#通过id服务查找用户：** ###

--------------------

Find User by id 是一个**GET**类型的服务。以下是服务 URL、语法和**POSTMAN**截图。

服务网址：http://localhost:8888/api/users/\{id\}

请求类型：GET

POSTMAN 请求截图

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 5][]

### **\#列出所有用户服务：** ###

--------------------

List Users 是一个**GET**类型的服务。以下是服务 URL、syntex 和**POSTMAN**截图。

服务地址：http://localhost:8888/api/users

请求类型：GET

POSTMAN 请求截图

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 6][]

### **\#删除用户服务：** ###

--------------------

删除用户是一个**DELETE**类型的服务。以下是服务 URL、语法和**POSTMAN**截图。

服务地址：http://localhost:8888/api/user/\{id\}

请求类型：**删除**

POSTMAN 请求截图

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 7][]

### **＃参考：** ###

--------------------

*  [https://spring.io/guides/gs/accessing-data-jpa/][https_spring.io_guides_gs_accessing-data-jpa]
 *  [https://spring.io/guides/gs/accessing-data-mysql/][https_spring.io_guides_gs_accessing-data-mysql]
 *  [https://docs.spring.io/spring-data/jpa/docs/current/reference/html/][https_docs.spring.io_spring-data_jpa_docs_current_reference_html]

### **＃源代码：** ###

--------------------

您可以从以下 GitHub 链接[下载][Link 2]源代码

[https://github.com/bhupeshpadiyar/spring-boot-mysql-rest][Link 2]

###  ###

[Link 1]: https://www.bhupeshsingh.com/about/
[e377f6c1cc85ab5878f49e0b3b6a5925.png]: https://img-blog.csdnimg.cn/img_convert/e377f6c1cc85ab5878f49e0b3b6a5925.png
[932116bb00f162b53ee5c880a5790062.png]: https://img-blog.csdnimg.cn/img_convert/932116bb00f162b53ee5c880a5790062.png
[http_start.spring.io]: http://start.spring.io/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20210601161704880.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20210601162051293.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20210601170817156.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/2021060116534039.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20210601165609757.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20210601165745318.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20210601170113198.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/20210601170155348.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI=,size_16,color_FFFFFF,t_70
[https_spring.io_guides_gs_accessing-data-jpa]: https://spring.io/guides/gs/accessing-data-jpa/
[https_spring.io_guides_gs_accessing-data-mysql]: https://spring.io/guides/gs/accessing-data-mysql/
[https_docs.spring.io_spring-data_jpa_docs_current_reference_html]: https://docs.spring.io/spring-data/jpa/docs/current/reference/html/
[Link 2]: https://github.com/bhupeshpadiyar/spring-boot-mysql-rest