易水风萧自定义通用开发组件是在日常开发过程中的一些常用工具类的积累。由于深感平时在 springboot 和 springcloud 的项目过程中需要反复引入大量相同的依赖包,从而带来的极大的不便,因此将在开发过程中将一些需要反复引用的依赖聚合起来,根据不同的颗粒度进行封装,方便开发。
一 通用工具包使用说明
本工具包主要集成了目前在项目开发过程中个人经常会使用到的一些工具类,对工具类进行了一下简单的封装。工具包目前集成了通用响应实体、对象拷贝、集合转换、加密工具、格式化工具、随机中文、JSR 校验、常用自定义异常、swagger-ui 和驼峰转换等工具。
maven 坐标作为:
目前最新版本为 1.2.4
通用工具包的结构如下:
1.1 常用重点工具类介绍
该工具主要用于将源对象里面的属性的值复制给目标对象。
使用方法如下:
该工具主要用于统一定义控制层返回参数。
该工具的主要属性定义如下:
注意:由于开启了空字段不序列化,因此在 msg 中携带的信息就已经很充分时,在返回接口中不会再出现 data 属性字段。自此段的具体含义需要查看具体接口的具体说明。
下面是一些常见的状态码的含义:
200: 请求已成功,请求所希望的响应头或数据体将随此响应返回
400: 语义有误,当前请求无法被服务器理解。除非进行修改,否则客户端不应该重复提交这个请求;请求参数有误。
401: 当前请求需要用户验证
403: 服务器已经理解请求,但是拒绝执行它
404: 请求失败,请求所希望得到的资源未被在服务器上发现
408: 请求超时。客户端没有在服务器预备等待的时间内完成一个请求的发送。客户端可以随时再次提交这一请求而无需进行任何更
422: 请求格式正确,但是由于含有语义错误,无法响应
500: 服务器遇到了一个未曾预料的状况,导致了它无法完成对请求的处理。一般来说,这个问题都会在服务器的程序码出错时出现。
501: 服务器不支持当前请求所需要的某个功能。当服务器无法识别请求的方法,并且无法支持其对任何资源的请求。
502: 作为网关或者代理工作的服务器尝试执行请求时,从上游服务器接收到无效的响应。
1.1.3 自定义异常
自定义异常的继承关系如下:
Exception继承关系
二 自定义聚合依赖
为了方便开发,将日常 springcloud 开发中使用到的依赖包聚合在一起,其引用坐标为:
此依赖中包含了日常开发过程中经常使用到 spring boot 依赖和 spring cloud 相关的依赖
springboot 依赖的集合
该依赖包的定义如下
data-spring-boot-starter
使用了该依赖后,包含的功能有:
通用 mapper
mybatis 分页插件
druid 连接池
redis
spring cache
该依赖的定义如下:
swagger-spring-boot-starter
swagger-spring-boot-starter 是基于 swagger-bootstrap-ui 的二次封装,将 swagger ui 相关的参数都封装到自定参数中。
该依赖主要包含的功能如下:
swagger-ui 启动配置
全局异常捕获
全局跨域支持
swagger ui 相关配置
开启 swagger-ui
其他参数说明:
高级配置
此配置参见 swagger ui 的 ParameterBuilder 用法配置
跨域支持配置
开启跨域支持
注意: 默认开启了跨域支持,如需关闭将值设置为 false 即可
spring cloud 依赖聚合
领取专属 10元无门槛券
私享最新 技术干货