一个完整的SpringBoot项目所需要导入的依赖与设置 与 SpringBoot项目中pom.xml文件各标签详解（持续更新中）

pom.xml文件各标签详解

Maven项目中有一个最核心的文件：pom.xml 文件

pom.xml文件是Maven项目中的核心项目管理文件，主要用于描述项目的：项目描述、配置文件、依赖管理、构建信息管理、组织信息管理和licenses、开发者需要遵循的规则、缺陷管理系统、项目的url、项目的依赖性，以及其他所有的项目相关因素。pom.xml 文件中包含了许多标签，下来介绍一些pom.xml文件常用的标签

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110 4.0.0 org.bailang SpringBoot-dependency-test 1.0-SNAPSHOT jar SpringBoot-dependency-test This is a SpringBootDependencyTest org.springframework.boot spring-boot-starter-parent 2.5.0 8 8 UTF-8 1.8 org.springframework.boot spring-boot-starter org.apache.maven.plugins maven-surefire-plugin true org.apache.maven.plugins maven-compiler-plugin 3.1 ${java.version} ${java.version} ${project.build.sourceEncoding}

项目依赖导入与设置

springboot 启动类依赖

12345 org.springframework.boot spring-boot-starter

springboot 测试类依赖

12345 org.springframework.boot spring-boot-starter-test

springboot Web开发依赖（包括Tomcat和spring-webmvc）

12345 org.springframework.boot spring-boot-starter-web

Lombok依赖（用来简化对类的操作包括：set方法、get方法以及构造函数等，只需要一个注解）

1234567 org.projectlombok lombok

Mybatis-Plus依赖

123456 com.baomidou mybatis-plus-boot-starter 3.4.3

application.yml文件 配置Mybatis-Plus

123456789101112mybatis-plus: configuration: # mybatis-plus日志 控制台输出 log-impl: org.apache.ibatis.logging.stdout.StdOutImpl global-config: db-config: # 逻辑删除 logic-delete-field: delFlag logic-delete-value: 1 logic-not-delete-value: 0 # id生成规则：数据库id自增 id-type: auto

MySql依赖

123456789101112 mysql mysql-connector-java

application.yml文件 配置数据库

1234567spring: # 数据库配置 datasource: url: jdbc:mysql://localhost:3306/mybatis-plus-crud-test?characterEncoding=utf-8&serverTimezone=Asia/Shanghai username: 数据库用户名 password: 数据库密码 driver-class-name: com.mysql.cj.jdbc.Driver

redis依赖

12345 org.springframework.boot spring-boot-starter-data-redis

fastjson依赖（可以将 Java对象 转换为 JSON格式，当然它也可以将 JSON字符串 转换为 Java对象）

123456 com.alibaba fastjson 1.2.33

jwt依赖

123456 io.jsonwebtoken jjwt 0.9.0

springboot devtools热部署依赖

12345678 org.springframework.boot spring-boot-devtools true runtime

SpringSecurity启动器

12345 org.springframework.boot spring-boot-starter-security

打包跳过测试 插件

12345678 org.apache.maven.plugins maven-surefire-plugin true

指定项目源码的 jdk 版本，编译后的 jdk 版本，以及编码 插件

1234567891011 org.apache.maven.plugins maven-compiler-plugin 3.1 ${java.version} ${java.version} ${project.build.sourceEncoding}

swagger依赖

12345678910111213141516 io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2 io.swagger swagger-models 1.5.21

完整 pom.xml文件

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196 4.0.0 org.springframework.boot spring-boot-starter-parent 2.5.0 org.bailang SpringBoot-dependency-test 1.0-SNAPSHOT jar SpringBoot-dependency-test This is a SpringBootDependencyTest 8 8 UTF-8 1.8 org.springframework.boot spring-boot-starter org.springframework.boot spring-boot-starter-test org.springframework.boot spring-boot-starter-web org.projectlombok lombok com.baomidou mybatis-plus-boot-starter 3.4.3 mysql mysql-connector-java org.springframework.boot spring-boot-starter-data-redis com.alibaba fastjson 1.2.33 io.jsonwebtoken jjwt 0.9.0 org.springframework.boot spring-boot-devtools true runtime org.springframework.boot spring-boot-starter-security io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2 io.swagger swagger-models 1.5.21 org.apache.maven.plugins maven-surefire-plugin true org.apache.maven.plugins maven-compiler-plugin 3.1 ${java.version} ${java.version} ${project.build.sourceEncoding}

完整 application.yml文件

12345678910111213141516171819202122232425262728293031323334353637383940# 服务端口（不设置默认：8080）server: port: 8070spring: # 数据库配置 datasource: url: jdbc:mysql://localhost:3306/mybatis-plus-crud-test?characterEncoding=utf-8&serverTimezone=Asia/Shanghai username: 数据库用户名 password: 数据库密码 driver-class-name: com.mysql.cj.jdbc.Driver servlet: # 文件上传大小限制 multipart: max-file-size: 2MB max-request-size: 5MB # redis配置 redis: host: redis的地址 port: redis的端口（redis默认端口：6379）mybatis-plus: configuration: # mybatis-plus日志 控制台输出 log-impl: org.apache.ibatis.logging.stdout.StdOutImpl global-config: db-config: # 逻辑删除 logic-delete-field: delFlag logic-delete-value: 1 logic-not-delete-value: 0 # id生成规则：数据库id自增 id-type: auto# 七牛云上传凭证 配置oss: accessKey: 七牛云的上传凭证 access key secretKey: 七牛云的上传凭证 secret key bucket: 存储数据使用的仓库名 bucket name qiniu_domain: 自定义域名

项目细节配置

设置主键自动增长

创建数据表的时候设置主键自增

实体字段中配置主键字段 增加注解@TableId(value = "id",type = IdType.AUTO) （如果上面application.yml文件中的mybatis-plus配置设置了id自增，则实体类可以不用设置字段自动增长，mybatis-plus自带雪花算法）

1234567@SuppressWarnings("serial")@TableName("user") // 标识表名public class User { @TableId // 标识主键ID //实体类可以不用设置字段自动增长，mybatis-plus自带雪花算法 private Long id;}

设置新增、更新自动填充功能（MP字段自动填充）

在实体类中，对需要进行自动填充的字段添加注解

12345678910111213141516171819@SuppressWarnings("serial")@Data@AllArgsConstructor@NoArgsConstructor@TableName("user") // 标识表名public class User { @TableField(fill = FieldFill.INSERT) //创建人的用户ID private Long createBy; @TableField(fill = FieldFill.INSERT) //创建时间 private Date createTime; @TableField(fill = FieldFill.INSERT_UPDATE) //更新人的用户ID private Long updateBy; @TableField(fill = FieldFill.INSERT_UPDATE) //更新时间 private Date updateTime;}

自定义类MyMetaObjectHandler，实现 MetaObjectHandler 接口，重写相应方法即刻

1234567891011121314151617181920212223242526272829303132/** * 配置MP字段自动填充：实现 MetaObjectHandler 接口，重写相应方法即刻 * * 如需实现字段自动填充，请给需要填充的字段添加注解，例：@TableField(fill = FieldFill.INSERT_UPDATE) 、 @TableField(fill = FieldFill.INSERT) */@Componentpublic class MyMetaObjectHandler implements MetaObjectHandler { // 配置MP字段自动填充：实现 MetaObjectHandler 接口，重写相应方法即刻 /** * 新增数据自动填充方法 * @param metaObject */ @Override public void insertFill(MetaObject metaObject) { System.out.println("进入MP自动填充 新增数据"); this.setFieldValByName("createBy", (long)3, metaObject); this.setFieldValByName("createTime", new Date(), metaObject); this.setFieldValByName("updateBy", (long)3, metaObject); this.setFieldValByName("updateTime", new Date(), metaObject); } /** * 更新数据自动填充方法 * @param metaObject */ @Override public void updateFill(MetaObject metaObject) { System.out.println("进入MP自动填充 更新数据"); this.setFieldValByName("updateBy", (long)3, metaObject); this.setFieldValByName("updateTime", new Date(), metaObject); }}

配置逻辑删除（实体类）

数据库中的逻辑删除字段 要与 application.yml中配置的逻辑删除字段一致

在实体类中的逻辑删除字段添加注解 @TableLogic

12345678910@SuppressWarnings("serial")@Data@AllArgsConstructor@NoArgsConstructor@TableName("user") // 标识表名public class User { //删除标志（0代表未删除，1代表已删除） @TableLogic // 逻辑删除 注释 private Integer delFlag;}

配置分页查询功能

1234567891011@Configurationpublic class MybatisPlusConfig { // MP支持 分页配置 @Bean public MybatisPlusInterceptor mybatisPlusInterceptor(){ MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor(); // 添加分页插件 mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor()); return mybatisPlusInterceptor; }}

自定义 统一响应类与响应code枚举类

响应code枚举类

1234567891011121314151617181920212223242526272829303132333435363738public enum AppHttpCodeEnum { SUCCESS(200, "操作成功"), // 成功 NEED_LOGIN(401, "需要登陆后操作"), // 登录 NO_OPERATOR_AUTH(403, "无权限操作"), SYSTEM_ERROR(500, "出现错误"), REQUIRE_USERNAME(504, "必须填写用户名"), LOGIN_ERROR(505, "用户名或密码错误"), CONTENT_NOT_NULL(506, "内容不能为空"), FILE_TYPE_ERROR(507, "文件格式错误，请上传正确格式的文件"), FILE_TOO_LARGE(413, "上传失败，文件过大"), USERNAME_NOT_NULL(508, "用户名不能为空"), NICKNAME_NOT_NULL(509, "昵称不能为空"), PASSWORD_NOT_NULL(510, "密码不能为空"), EMAIL_NOT_NULL(511, "邮箱不能为空"), USERNAME_EXIST(501, "用户名已存在"), PHONENUMBER_EXIST(502, "手机号已存在"), EMAIL_EXIST(503, "邮箱已存在"), NICKNAME_EXIST(512, "昵称已存在"); private final int code; private final String msg; AppHttpCodeEnum(int code, String errorMsg) { this.code = code; this.msg = errorMsg; } public int getCode() { return code; } public String getMsg() { return msg; }}

统一响应类

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121@JsonInclude(JsonInclude.Include.NON_NULL)public class ResponseResult implements Serializable { private Integer code; private String msg; private T data; public ResponseResult() { this.code = AppHttpCodeEnum.SUCCESS.getCode(); this.msg = AppHttpCodeEnum.SUCCESS.getMsg(); } public ResponseResult(Integer code, T data) { this.code = code; this.data = data; } public ResponseResult(Integer code, String msg, T data) { this.code = code; this.msg = msg; this.data = data; } public ResponseResult(Integer code, String msg) { this.code = code; this.msg = msg; } public static ResponseResult okResult(){ ResponseResult result = new ResponseResult(); return result; } public static ResponseResult okResult(int code, String msg){ ResponseResult result = new ResponseResult(); return result.ok(code, msg, null); } public static ResponseResult okResult(Object data){ ResponseResult result = setAppHttpCodeEnum(AppHttpCodeEnum.SUCCESS, AppHttpCodeEnum.SUCCESS.getMsg()); if(data!=null){ result.setData(data); } return result; } public static ResponseResult errorResult(int code, String msg){ ResponseResult result = new ResponseResult(); return result.error(code, msg); } public static ResponseResult errorResult(AppHttpCodeEnum enums){ ResponseResult result = setAppHttpCodeEnum(enums, enums.getMsg()); return result; } public static ResponseResult errorResult(AppHttpCodeEnum enums, String msg){ ResponseResult result = setAppHttpCodeEnum(enums, msg); return result; } public static ResponseResult setAppHttpCodeEnum(AppHttpCodeEnum enums){ return okResult(enums.getCode(), enums.getMsg()); } public static ResponseResult setAppHttpCodeEnum(AppHttpCodeEnum enums, String msg){ return okResult(enums.getCode(), msg); } public ResponseResult error(Integer code, String msg){ this.code = code; this.msg = msg; return this; } public ResponseResult ok(Integer code, T data){ this.code = code; this.data = data; return this; } public ResponseResult ok(Integer code, String msg, T data){ this.code = code; this.msg = msg; this.data = data; return this; } public ResponseResult ok(T data){ this.data = data; return this; } public Integer getCode() { return code; } public void setCode(Integer code) { this.code = code; } public String getMsg() { return msg; } public void setMsg(String msg) { this.msg = msg; } public T getData() { return data; } public void setData(T data) { this.data = data; }}

统一异常处理 与 自定义异常处理

需要在 handler处理包 下新建一个 GlobalExceptionHandler全局异常统一处理配置类，否侧出现异常前端不会直接提示500错误代码与错误信息

自定义异常

1234567891011121314151617181920212223242526272829303132333435363738/** * 自定义系统异常 */public class SystemException extends RuntimeException{ private int code; private String msg; public int getCode() { return code; } public String getMsg() { return msg; } public SystemException(AppHttpCodeEnum appHttpCodeEnum){ super(appHttpCodeEnum.getMsg()); this.code = appHttpCodeEnum.getCode(); this.msg = appHttpCodeEnum.getMsg(); } public SystemException(AppHttpCodeEnum appHttpCodeEnum, String msg){ super(msg); this.code = appHttpCodeEnum.getCode(); this.msg = msg; } public SystemException(int code, String msg){ super(msg); this.code = code; this.msg = msg; }}

全局异常统一处理配置类

12345678910111213141516171819202122232425262728293031323334353637/** * 全局异常统一处理配置类 * *///@ControllerAdvice//@ResponseBody@RestControllerAdvice // @ControllerAdvice+@ResponseBody 复合注解@Slf4j // 日志public class GlobalExceptionHandler { // 统一异常处理 // 自定义异常处理 @ExceptionHandler(SystemException.class) public ResponseResult systemExceptionHandler(SystemException e){ System.out.println("进入系统异常: "+e.toString()); // 打印异常信息 log.error("出现了异常！ {}", e.toString(), e); // 从异常对象中获取信息封装result返回 ResponseResult result = ResponseResult.errorResult(e.getCode(), e.getMsg()); return result; } // 统一异常处理 @ExceptionHandler(Exception.class) public ResponseResult exceptionHandler(Exception e){ System.out.println("进入全局Exception异常: "+e.toString()); // 打印异常信息 log.error("出现了异常！ {}", e.toString(), e); // 从异常对象中获取信息封装result返回 ResponseResult result = ResponseResult.errorResult(AppHttpCodeEnum.SYSTEM_ERROR, e.getMessage()); return result; }}

配置七牛云OSS服务

在 application.yml文件 中设置 上传凭证 与 仓库名（非必要），上传代码和工具类的代码实现参考下列的博客：

七牛云文件上传代码模板（Java）

redis配置

导入依赖后，在 application.yml文件 中配置 redis地址与端口信息，工具类代码实现如下：

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217@SuppressWarnings(value = { "unchecked", "rawtypes" })@Componentpublic class RedisCache { @Autowired public RedisTemplate redisTemplate; /** * 缓存基本的对象，Integer、String、实体类等 * * @param key 缓存的键值 * @param value 缓存的值 */ public void setCacheObject(final String key, final T value) { redisTemplate.opsForValue().set(key, value); } /** * 缓存基本的对象，Integer、String、实体类等 * * @param key 缓存的键值 * @param value 缓存的值 * @param timeout 时间 * @param timeUnit 时间颗粒度 */ public void setCacheObject(final String key, final T value, final Integer timeout, final TimeUnit timeUnit) { redisTemplate.opsForValue().set(key, value, timeout, timeUnit); } /** * 设置有效时间 * * @param key Redis键 * @param timeout 超时时间 * @return true=设置成功；false=设置失败 */ public boolean expire(final String key, final long timeout) { return expire(key, timeout, TimeUnit.SECONDS); } /** * 设置有效时间 * * @param key Redis键 * @param timeout 超时时间 * @param unit 时间单位 * @return true=设置成功；false=设置失败 */ public boolean expire(final String key, final long timeout, final TimeUnit unit) { return redisTemplate.expire(key, timeout, unit); } /** * 获得缓存的基本对象。 * * @param key 缓存键值 * @return 缓存键值对应的数据 */ public T getCacheObject(final String key) { ValueOperations operation = redisTemplate.opsForValue(); return operation.get(key); } /** * 删除单个对象 * * @param key */ public boolean deleteObject(final String key) { return redisTemplate.delete(key); } /** * 删除集合对象 * * @param collection 多个对象 * @return */ public long deleteObject(final Collection collection) { return redisTemplate.delete(collection); } /** * 缓存List数据 * * @param key 缓存的键值 * @param dataList 待缓存的List数据 * @return 缓存的对象 */ public long setCacheList(final String key, final List dataList) { Long count = redisTemplate.opsForList().rightPushAll(key, dataList); return count == null ? 0 : count; } /** * 获得缓存的list对象 * * @param key 缓存的键值 * @return 缓存键值对应的数据 */ public List getCacheList(final String key) { return redisTemplate.opsForList().range(key, 0, -1); } /** * 缓存Set * * @param key 缓存键值 * @param dataSet 缓存的数据 * @return 缓存数据的对象 */ public BoundSetOperations setCacheSet(final String key, final Set dataSet) { BoundSetOperations setOperation = redisTemplate.boundSetOps(key); Iterator it = dataSet.iterator(); while (it.hasNext()) { setOperation.add(it.next()); } return setOperation; } /** * 获得缓存的set * * @param key * @return */ public Set getCacheSet(final String key) { return redisTemplate.opsForSet().members(key); } /** * 缓存Map * * @param key * @param dataMap */ public void setCacheMap(final String key, final Map dataMap) { if (dataMap != null) { redisTemplate.opsForHash().putAll(key, dataMap); } } /** * 获得缓存的Map * * @param key * @return */ public Map getCacheMap(final String key) { return redisTemplate.opsForHash().entries(key); } /** * 往Hash中存入数据 * * @param key Redis键 * @param hKey Hash键 * @param value 值 */ public void setCacheMapValue(final String key, final String hKey, final T value) { redisTemplate.opsForHash().put(key, hKey, value); } /** * 获取Hash中的数据 * * @param key Redis键 * @param hKey Hash键 * @return Hash中的对象 */ public T getCacheMapValue(final String key, final String hKey) { HashOperations opsForHash = redisTemplate.opsForHash(); return opsForHash.get(key, hKey); } /** * 删除Hash中的数据 * * @param key * @param hkey */ public void delCacheMapValue(final String key, final String hkey) { HashOperations hashOperations = redisTemplate.opsForHash(); hashOperations.delete(key, hkey); } /** * 获取多个Hash中的数据 * * @param key Redis键 * @param hKeys Hash键集合 * @return Hash对象集合 */ public List getMultiCacheMapValue(final String key, final Collection