后端项目SpringBoot+JPA+Swagger
1.数据库设计
CREATE TABLE IF NOT EXISTS `sys_user` (
`id` BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT '主键ID',
`username` VARCHAR(255) DEFAULT NULL COMMENT '用户名',
`nickname` VARCHAR(255) DEFAULT NULL COMMENT '用户昵称',
`password` VARCHAR(64) DEFAULT NULL COMMENT '密码',
`salt` VARCHAR(255) DEFAULT NULL COMMENT '密码盐',
`dept_id` BIGINT(20) DEFAULT NULL COMMENT '部门ID',
`picture` VARCHAR(255) DEFAULT NULL COMMENT '头像',
`sex` TINYINT(4) DEFAULT NULL COMMENT '性别(1:男,2:女)',
`email` VARCHAR(255) DEFAULT NULL COMMENT '邮箱',
`phone` VARCHAR(255) DEFAULT NULL COMMENT '电话号码',
`remark` VARCHAR(255) DEFAULT NULL COMMENT '备注',
`create_date` DATETIME DEFAULT NULL COMMENT '创建时间',
`update_date` DATETIME DEFAULT NULL COMMENT '更新时间',
`status` TINYINT(4) DEFAULT NULL COMMENT '状态(1:正常,2:冻结,3:删除)',
PRIMARY KEY (`id`)
) ENGINE=INNODB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;
-- 正在导出表 timo.sys_user 的数据:~2 rows (大约)
/*!40000 ALTER TABLE `sys_user` DISABLE KEYS */;
INSERT INTO `sys_user` (`id`, `username`, `nickname`, `password`, `salt`, `dept_id`, `picture`, `sex`, `email`, `phone`, `remark`, `create_date`, `update_date`, `status`) VALUES
(1, 'admin', '超级管理员', '5fa04c0758ae596e2a93cd2802640693a5b08bdfacd4307abce323c85e481154', '7rl2t9', 1, NULL, 1, '10086@163.com', '10086', '', '2018-08-09 23:00:03', '2019-11-06 20:09:17', 1),
(2, 'linln', '小懒虫', '28bfc4f19b0d4b8a40018faf9aec4ad9db5491082dda439040b1c35ff8c533a7', 'gzNkXt', 2, NULL, 2, '1008612@qq.com', '1008612', '', '2018-09-30 16:25:22', '2019-11-06 20:09:17', 1);
/*!40000 ALTER TABLE `sys_user` ENABLE KEYS */;
项目目录
2.搭建SpringBoot环境
导入依赖pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.4</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.ylk</groupId>
<artifactId>sbtdemo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>sbtdemo</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- 连接数据库整合jpa-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.49</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.2.8</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<!-- swagger依赖-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
2.配置application.yml文件
spring:
mvc:
pathmatch:
matching-strategy: ant_path_matcher
datasource:
type: com.alibaba.druid.pool.DruidDataSource
url: jdbc:mysql://localhost:3306/springboot?useSSL=false&serverTimezone=UTC&characterEncoding=UTF-8
username: root
password: root
jpa:
database: mysql
show-sql: true
hibernate:
ddl-auto: update
properties:
hibernate:
format_sql: true
server:
port: 8888
swagger:
basepackage: com.ylk.controller
title: spring boot jpa swagger vue
descri: this is spring boot jpa swagger with vue
version: 1.0
contact: ylk
3.编写代码
3.1pojo层
jpa创建实体类
package com.ylk.pojo;
import lombok.Data;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import java.util.Date;
@Entity
@Data
public class User {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private int id;
private String username;
private String nickname;
private String password;
private String salt;
private int dept_id;
private String picture;
private int sex;
private String email;
private String phone;
private Date create_date;
private Date update_date;
private int status;
}
前端向后端传递数据所需要的实体类
package com.ylk.pojo;
import lombok.Data;
import java.util.List;
@Data
public class Multi {
List<String> cids;
}
3.2dao层
package com.ylk.dao;
import com.ylk.pojo.User;
import org.springframework.data.jpa.repository.JpaRepository;
public interface IUserDao extends JpaRepository<User,Integer> {
}
3.3service层
package com.ylk.service;
import com.ylk.pojo.User;
import java.util.List;
public interface IUserService {
List<User> getAllUser();
User getUserById(int id);
Boolean saveUser(User user);
Boolean deleteById(int id);
List<User> testSplit(Integer pageNum,Integer pageSize);
boolean deleteMul(List<String> cids);
}
接口实现类
package com.ylk.service.Impl;
import com.ylk.dao.IUserDao;
import com.ylk.pojo.User;
import com.ylk.service.IUserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class UserServiceImpl implements IUserService{
@Autowired
private IUserDao iUserDao;
@Override
public User getUserById(int id) {
return iUserDao.findById(id).get();
}
@Override
public Boolean saveUser(User user) {
return iUserDao.saveAndFlush(user) != null;
}
@Override
public Boolean deleteById(int id) {
try {
if(id > 0){
iUserDao.deleteById(id);
return true;
}
} catch (Exception e) {
e.printStackTrace();
}
return false;
}
@Override
public List<User> testSplit(Integer pageNum, Integer pageSize) {
// Pageable pageable = PageRequest.of(pageNum,pageSize);
PageRequest pageReques = PageRequest.of(pageNum, pageSize);
Page<User> userPage = iUserDao.findAll(pageReques);
List<User> list = userPage.getContent();
return list;
}
@Override
public boolean deleteMul(List<String> ids) {
try {
if(ids != null){
for (String id : ids) {
iUserDao.deleteById(Integer.parseInt(id));
}
return true;
}
} catch (NumberFormatException e) {
e.printStackTrace();
}
return false;
}
@Override
public List<User> getAllUser() {
return iUserDao.findAll();
}
}
3.4controller层
package com.ylk.controller;
import com.ylk.pojo.Multi;
import com.ylk.pojo.User;
import com.ylk.service.IUserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private IUserService ius;
@GetMapping("/getAll")
public List<User> getAll(){
return ius.getAllUser();
}
@GetMapping("/{id}")
public User getUserById(@PathVariable int id){
return ius.getUserById(id);
}
@PostMapping("/saveUser")
public Boolean saveUser(@RequestBody User user){
return ius.saveUser(user);
}
@PostMapping("/deleteById/{id}")
public Boolean deleteById(@PathVariable int id){
return ius.deleteById(id);
}
// @DeleteMapping("/deleteById")
// public Boolean deleteById(@RequestParam(name = "id") int id){
// return ius.deleteById(id);
// }
@GetMapping("/usersPage")
public List<User> usersByPage(@RequestParam(value = "page",required = false,defaultValue = "0") Integer page,
@RequestParam(value = "pageSize",required = false,defaultValue = "1") Integer pageSize){
return ius.testSplit(page, pageSize);
}
@PostMapping("/deleteMul")
public boolean deleteMul(@RequestBody Multi ids){
return ius.deleteMul(ids.getCids());
}
}
4.添加swagger
4.1在配置文件中进行配置
package com.ylk.config;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Value("${swagger.basepackage}")
private String basePackage;
@Value("${swagger.title}")
private String title;
@Value("${swagger.descri}")
private String descri;
@Value("${swagger.version}")
private String version;
@Value("${swagger.contact}")
private String contact;
@Bean
public Docket getSwagger(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(getInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(basePackage))
.paths(PathSelectors.any())
.build();
}
public ApiInfo getInfo(){
return new ApiInfoBuilder()
.title(title)
.description(descri)
.version(version)
.contact(contact)
.build();
}
}
4.2进行swagger的接口测试
swagger接口测试URL:http://localhost:8888/swagger-ui.html