SpringBoot项目合集
SpringBoot项目合集
文章目录
一、可能遇到的问题
1. Lombok插件使用不了
将pom.xml文件中的build下Lombok注釋或刪除
<build>
<plugins>
<!--<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<annotationProcessorPaths>
<path>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>-->
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<!--<configuration>
<excludes>
<exclude>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclude>
</excludes>
</configuration>-->
</plugin>
</plugins>
</build>
在dependency中加入
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.36</version>
</dependency>
最后运行后在target下的实体类进行检查是否自动注入了getter、setter等方法

二、统一Result返回类
设置统一返回结果
package com.wudreamer.learn1.common;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@NoArgsConstructor
public class Result<T> {
// 状态码
private int code;
// 消息
private String msg;
// 数据
private T data;
/**
* 私有构造方法,禁止直接创建对象
*/
private Result(int code, String msg, T data) {
this.code = code;
this.msg = msg;
this.data = data;
}
// 常用状态码常量(可根据项目需要扩展)
public static final int SUCCESS_CODE = 200;
public static final int ERROR_CODE = 500;
/**
* 成功(无数据)
*/
public static <T> Result<T> success() {
return new Result<>(SUCCESS_CODE, "操作成功", null);
}
/**
* 成功(带数据)
*/
public static <T> Result<T> success(T data) {
return new Result<>(SUCCESS_CODE, "操作成功", data);
}
/**
* 成功(自定义消息)
*/
public static <T> Result<T> success(String msg, T data) {
return new Result<>(SUCCESS_CODE, msg, data);
}
/**
* 失败(默认状态码和消息)
*/
public static <T> Result<T> error() {
return new Result<>(ERROR_CODE, "系统异常,请联系管理员", null);
}
/**
* 失败(自定义消息)
*/
public static <T> Result<T> error(String msg) {
return new Result<>(ERROR_CODE, msg, null);
}
/**
* 失败(自定义状态码和消息)
*/
public static <T> Result<T> error(int code, String msg) {
return new Result<>(code, msg, null);
}
// ------------------- Getter 方法 -------------------
public int getCode() {
return code;
}
public String getMsg() {
return msg;
}
public T getData() {
return data;
}
// ------------------- 链式调用方法(可选) -------------------
/**
* 设置消息(链式调用)
*/
public Result<T> msg(String msg) {
this.msg = msg;
return this;
}
/**
* 设置数据(链式调用)
*/
public Result<T> data(T data) {
this.data = data;
return this;
}
}
三、集成Sagger生成API文档(knife4j)
1.第一种类型
1.1、导入swagger集成Knife4j的maven坐标依赖
<!--Swagger接口文档依赖-->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
2、在WebMvcConfiguration 配置类中加入knife4j相关配置
/**
* 通过knife4j生成接口文档
* @return
*/
@Bean
public Docket docket1() {
// log.info("准备生成接口文档...");
ApiInfo apiInfo = new ApiInfoBuilder()
.title("xx项目接口文档")
.version("2.0")
.description("xx项目接口文档")
.build();
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.groupName("管理端接口")
.apiInfo(apiInfo)
.select()
// 指定生成接口需要扫描的包,admin是管理端
.apis(RequestHandlerSelectors.basePackage("com.sky.controller.admin"))
.paths(PathSelectors.any())
.build();
return docket;
}
/**
* 通过knife4j生成接口文档
* @return
*/
@Bean
public Docket docket2() {
//log.info("准备生成接口文档...");
ApiInfo apiInfo = new ApiInfoBuilder()
.title("xx项目接口文档")
.version("2.0")
.description("xx项目接口文档")
.build();
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.groupName("用户端接口")
.apiInfo(apiInfo)
.select()
// 指定生成接口需要扫描的包,user是用户端
.apis(RequestHandlerSelectors.basePackage("com.sky.controller.user"))
.paths(PathSelectors.any())
.build();
return docket;
}

3、设置静态资源映射,否则接口文档页面无法访问
/**
* 设置静态资源映射,主要是访问接口文档(html、js、css)
* @param registry
*/
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
//log.info("开始设置静态资源映射...");
registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}

4、运行进行打开接口文档
地址:localhost:xxxx/doc.html
2.第二种类(法一我不行)
2.1 导入依赖
<!--Swagger接口文档依赖-->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.1.0</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
<version>4.3.0</version>
</dependency>
2.2 在config包下创建OpenApiConfig配置类
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
@Configuration
public class OpenApiConfig extends WebMvcConfigurationSupport {
// 配置 OpenAPI 基本信息
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.info(new Info()
.title("墨执项目接口文档")
.version("1.0")
.description("墨执项目接口文档-练习版"));
}
// 配置 API 分组(管理端接口)
@Bean
public GroupedOpenApi adminApi() {
return GroupedOpenApi.builder()
.group("管理端接口")
.packagesToScan("com.wudreamer.learn1.controller") // 扫描的包路径
.pathsToMatch("/**") // 匹配所有路径
.build();
}
// 静态资源映射(Knife4j 需要)
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/doc.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
2.3 在运行入口类添加@EnableKnife4j 注解
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@EnableKnife4j // 集成Knife4j生成接口文档
public class Learn1Application {
public static void main(String[] args) {
SpringApplication.run(Learn1Application.class, args);
}
}
2.4 在controller接口层中使用注解
@Tag(name = "用户接口") // 在每个接口类 前添加
@Operation(summary = "新增用户") // 在每个接口前添加



2.4 运行测试打开接口文档
运行:http://localhost:8085/doc.html

四、用户业务代码开发
1.save新增用户业务代码开发
1.1 entity下用户实体层
import lombok.Data;
/**
* 功能:用户实体类
* 作者:执笔揽星
* 日期:2025/3/31 21:50
*/
@Data
public class User {
private Integer id;
private String username;
private String password;
private String nickname;
private String phone;
private String email;
private String address;
private String avatar;
}
1.2.UserMapper业务代码开发
import com.wudreamer.learn1.entity.User;
import org.apache.ibatis.annotations.Mapper;
/**
* 功能:用户数据访问层
* 作者:执笔揽星
* 日期:2025/3/31 21:52
*/
@Mapper
public interface UserMapper {
/**
* 插入一条数据
* @param user
*/
void insert(User user);
}
1.3.UserMapper.xml数据库操作
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.wudreamer.learn1.mapper.UserMapper">
<!--插入一条数据-->
<insert id="insert" useGeneratedKeys="true" keyProperty="id">
insert into user (username,password,nickname,phone,email,address,avatar)
values (#{username},#{password},#{nickname},#{phone},#{email},#{address},#{avatar})
</insert>
</mapper>
1.4.UserService代码开发
import com.wudreamer.learn1.entity.User;
/**
* 功能:服务层
* 作者:执笔揽星
* 日期:2025/3/31 22:13
*/
public interface UserService {
// 添加用户
void insertUser(User user);
}
1.5.UserServiceImpl代码开发
import com.wudreamer.learn1.mapper.UserMapper;
import com.wudreamer.learn1.service.UserService;
import com.wudreamer.learn1.entity.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
/**
* 功能:用户数据业务操作
* 作者:执笔揽星
* 日期:2025/3/31 22:17
*/
@Service
public class UserServiceImpl implements UserService {
@Autowired
private UserMapper userMapper;
/**
* 新增一个用户
* @param user
*/
@Override
public void insertUser(User user) {
userMapper.insert(user);
}
}
1.6UserContronller代码开发
package com.wudreamer.learn1.controller;
import com.wudreamer.learn1.common.Result;
import com.wudreamer.learn1.entity.User;
import com.wudreamer.learn1.service.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.dao.DuplicateKeyException;
import org.springframework.web.bind.annotation.*;
/**
* 功能:
* 作者:执笔揽星
* 日期:2025/4/1 14:46
*/
@RestController
@RequestMapping("/user")
@Api(tags="用户接口")
public class UserController {
// 注入用户类的服务层
@Autowired
private UserService userService;
/**
* 新增用户
* @param user
* @return
*/ //json格式的数据通过@RequestBody注解自动绑定到User对象上
@PostMapping("/save")
@ApiOperation("新增用户")
public Result save(@RequestBody User user){
userService.insertUser(user);
return Result.success();
}
}
更加优化方式,防止前端报错:
@PostMapping("/save")
@ApiOperation("新增用户")
// 更好的处理错误,使前端不报错
public Result save(@RequestBody User user){
try{
userService.insertUser(user);
} catch (Exception e){
if (e instanceof DuplicateKeyException){
return Result.error("插入数据库错误");
} else {
return Result.error("系统错误");
}
}
return Result.success();
}
1.7运行测试
post方式请求localhost:8085/user/save
2.update修改用户业务代码开发
2.1UserMapper层
/**
* 修改用户
* @param user
*/
void update(User user);
2.2UserMapper.xml数据库操作
<!--修改用户信息-->
<update id="update">
update user set username = #{username},password = #{password},
nickname = #{nickname},phone = #{phone},email = #{email},
address = #{address},avatar = #{avatar}
where id = #{id}
</update>
2.3UserService层
// 修改用户
void updateUser(User user);
2.4UserServiceImpl层
/**
* 修改用户
* @param user
*/
@Override
public void updateUser(User user) {
userMapper.update(user);
}
2.5UserController层
/**
* 修改用户接口
* @param user
* @return
*/
@PutMapping("/update")
@ApiOperation("修改用户")
public Result update(@RequestBody User user){
userService.updateUser(user);
return Result.success();
}
2.6 运行测试
put方式下运行localhost:8085/user/update
3.delete删除用户业务代码(含单个删除和批量删除)
3.1 UserMapper 数据访问层
/**
* 根据Id删除单个用户
* @param id
* @return
*/
void delete(Integer id);
/**
* 根据ids批量删除用户
* @param ids
*/
void deleteUserByIds(List<Integer> ids);
3.2 UserMapper.xml SQL映射
<!--根据id删除单个用户-->
<delete id="delete">
delete from user where id = #{id}
</delete>
<!--批量删除用户-->
<delete id="deleteUserByIds">
delete from user where id in
<foreach collection="list" item="id" open="(" separator="," close=")">
#{id}
</foreach>
</delete>
3.3 UserService业务逻辑层
// 根据Id删除单个用户
void deleteUserById(Integer id);
// 根据id进行批量删除用户
void deleteUserByIds(List<Integer> ids);
3.4 UserServiceImpl 业务实现层
/**
* 根据Id删除单个用户
* @param id
*/
@Override
public void deleteUserById(Integer id) {
userMapper.delete(id);
}
/**
* 根据ids批量删除用户
* @param ids
*/
@Override
public void deleteUserByIds(List<Integer> ids) {
userMapper.deleteUserByIds(ids);
}
3.5 UserController 控制层
/**
* 根据Id删除单个用户
* @param id
* @return
*/
@DeleteMapping("/delete/{id}")
@ApiOperation("根据Id删除单个用户")
public Result delete(@PathVariable Integer id){
userService.deleteUserById(id);
return Result.success();
}
/**
* 根据Ids批量删除用户
* @param ids
* @return
*/
@DeleteMapping("/delete/batch")
@ApiOperation("根据Ids批量删除用户")
public Result deleteUsers(@RequestBody List<Integer> ids){
userService.deleteUserByIds(ids);
return Result.success();
}
3.6 运行测试
单个删除用户测试
delete下输入localhost:8085/user/delete/7
批量删除用户测试
delete下输入localhost:8085/user/delete/batch,注意要输入数组[x,x,x,…] 形式
4.select查询用户业务代码(含全部查询、排序查询、单条件、多条件、模糊查询、分页模糊查询)
4.1 UserMapper 数据访问层
/**
* 查询所有用户
* @return
*/
List<User> selectAll();
/**
* 根据id查询单个用户
* @param id
*/
User selectById(Integer id);
/**
* 根据username查询单个用户
* @param username
* @return
*/
User selectByUsername(String username);
/**
* 多条件查询用户
* @param username
* @param nickname
* @return
*/
List<User> selectByMore(String username, String nickname);
/**
* 多条件模糊查询
* @param username
* @param nickname
* @return
*/
List<User> selectByLike(String username, String nickname);
4.2 UserMapper.xml SQL映射
<!--倒序查询所有用户-->
<select id="selectAll" resultType="com.wudreamer.learn1.entity.User">
select *
from user
order by id desc
</select>
<!--根据ID查询单个用户-->
<select id="selectById" resultType="com.wudreamer.learn1.entity.User">
select *
from user
where id = #{id}
</select>
<!--根据username查询单个用户-->
<select id="selectByUsername" resultType="com.wudreamer.learn1.entity.User">
select *
from user
where username = #{username}
</select>
<!--多条件查询用户-->
<select id="selectByMore" resultType="com.wudreamer.learn1.entity.User">
select *
from user
where username = #{username}
and nickname = #{nickname}
</select>
<!--多条件模糊查询-->
<select id="selectByLike" resultType="com.wudreamer.learn1.entity.User">
select *
from user
where username like concat('%', #{username}, '%')
and nickname like concat('%', #{nickname}, '%')
order by id desc
</select>
4.3 UserService业务逻辑层
/*
* 查询操作
* */
// 查询所有用户
List<User> selectAllUser();
// 根据id查询单个用户
User selectUserById(Integer id);
// 根据用户名查询单个用户
User selectUserByUsername(String username);
// 多条件查询用户
List<User> selectUserMore(String username, String nickname);
// 多条件模糊查询
List<User> selectUserByLike(String username, String nickname);
4.4 UserServiceImpl 业务实现层
/**
* 查询所有用户
* @return
*/
@Override
public List<User> selectAllUser() {
return userMapper.selectAll();
}
/**
* 根据id查询单个用户
*
* @param id
* @return
*/
@Override
public User selectUserById(Integer id) {
return userMapper.selectById(id);
}
/**
* 根据username查询单个用户
* @param username
* @return
*/
@Override
public User selectUserByUsername(String username) {
return userMapper.selectByUsername(username);
}
/**
* 多条件查询用户
* @param username
* @param nickname
* @return
*/
@Override
public List<User> selectUserMore(String username, String nickname) {
return userMapper.selectByMore(username,nickname);
}
/**
* 多条件模糊查询
* @param username
* @param nickname
* @return
*/
@Override
public List<User> selectUserByLike(String username, String nickname) {
return userMapper.selectByLike(username,nickname);
}
4.5 UserController 控制层
/**
* 查询所有用户
*
* @return
*/
@GetMapping("/selectAll")
@ApiOperation("查询所有用户")
public Result selectAll() {
List<User> userList = userService.selectAllUser(); // 需要返回数据 alt + enter
return Result.success(userList);
}
/**
* 根据id查询单个用户
*
* @return
*/
@GetMapping("/selectById/{id}")
@ApiOperation("根据id查询单个用户")
public Result selectById(@PathVariable Integer id) {
User user = userService.selectUserById(id); // 需要返回数据 alt + enter
return Result.success(user);
}
/**
* 根据username查询单个用户
*
* @return
*/
@GetMapping("/selectByUsername/{username}")
@ApiOperation("根据username查询单个用户")
public Result selectByUsername(@PathVariable String username) {
User user = userService.selectUserByUsername(username); // 需要返回数据 alt + enter
return Result.success(user);
}
/**
* 多条件查询单个用户
*
* @return
*/
@GetMapping("/selectByMore")
@ApiOperation("多条件查询单个用户")
public Result selectByMore(@RequestParam String username , @RequestParam String nickname) {
List<User> userList = userService.selectUserMore(username,nickname); // 需要返回数据 alt + enter
return Result.success(userList);
}
/**
* 多条件模糊查询单个用户
*
* @return
*/
@GetMapping("/selectByLike")
@ApiOperation("多条件查询单个用户")
public Result selectByLike(@RequestParam String username , @RequestParam String nickname) {
List<User> userList = userService.selectUserByLike(username, nickname);// 需要返回数据 ctrl + alt + v
return Result.success(userList);
}
4.6 运行测试
查询所有用户:localhost:8085/user/selectAll
根据id查询单个用户:localhost:8085/user/selectById/13
根据username查询单个用户:http://localhost:8085/user/selectByUsername/admin
多条件查询单个用户:http://localhost:8085/user/selectByMore?username=admin&nickname=鸣人
多条件模糊查询单个用户:http://localhost:8085/user/selectByLike?username=wu&nickname=吴
5.分页查询用户业务代码
5.0 封装准备一个公共的Page类
package com.wudreamer.learn1.common;
import lombok.Data;
import java.util.List;
/**
* 功能:分页公共类
* 作者:执笔揽星
* 日期:2025/4/2 15:31
*/
@Data
public class Page<T> {
private Integer total;
private List<T> list;
}
5.1 UserMapper 数据访问层
/**
* 实现分页查询,传递页码,页数
*
* @param skipNum
* @param pageSize
* @return
*/
List<User> selectByPage(Integer skipNum, Integer pageSize);
/**
* 实现分页返回总数
*
* @return
*/
Integer selectCountByPage();
5.2 UserMapper.xml SQL映射
<!--实现分页查询,传递页码、页数-->
<select id="selectByPage" resultType="com.wudreamer.learn1.entity.User">
select *
from user
order by id desc
limit #{skipNum}, #{pageSize}
</select>
<!--分页查询返回总数-->
<select id="selectCountByPage" resultType="java.lang.Integer">
select count(id)
from user
order by id desc
</select>
5.3 UserService业务逻辑层
// 分页查询
Page<User> selectByPage(Integer pageNum, Integer pageSize);
5.4 UserServiceImpl 业务实现层
/**
* 分页查询
* @param pageNum
* @param pageSize
* @return
*/
@Override
public Page<User> selectByPage(Integer pageNum, Integer pageSize) {
Integer skipNum = (pageNum - 1) * pageSize;
Page<User> page = new Page<>();
List<User> userList = userMapper.selectByPage(skipNum, pageSize);
Integer total = userMapper.selectCountByPage();
page.setTotal(total);
page.setList(userList);
return page;
}
5.5 UserController 控制层
/**
* 实现分页查询
* @param pageNum
* @param pageSize
* @return
*/
@GetMapping("/selectPage")
public Result selectPage(@RequestParam Integer pageNum,
@RequestParam Integer pageSize){
Page<User> page = userService.selectByPage(pageNum,pageSize);
return Result.success(page);
}
5.6 运行测试
分页查询:http://localhost:8085/user/selectPage?pageNum=2&pageSize=3
am pageNum
* @param pageSize
* @return
*/
@Override
public Page selectByPage(Integer pageNum, Integer pageSize) {
Integer skipNum = (pageNum - 1) * pageSize;
Page<User> page = new Page<>();
List<User> userList = userMapper.selectByPage(skipNum, pageSize);
Integer total = userMapper.selectCountByPage();
page.setTotal(total);
page.setList(userList);
return page;
}
#### 5.5 UserController 控制层
~~~java
/**
* 实现分页查询
* @param pageNum
* @param pageSize
* @return
*/
@GetMapping("/selectPage")
public Result selectPage(@RequestParam Integer pageNum,
@RequestParam Integer pageSize){
Page<User> page = userService.selectByPage(pageNum,pageSize);
return Result.success(page);
}
5.6 运行测试
分页查询:http://localhost:8085/user/selectPage?pageNum=2&pageSize=3

更多推荐


所有评论(0)