1. 简介

本项目是集成了开发的常用工具类库，包含一些自己实现的工具。

项目集成了：

• hutool-all
• spring-boot-starter-validation

2. 快速开始

Maven依赖：

<dependency>
    <groupId>cn.surcode</groupId>
    <artifactId>surtools-spring-boot-starter</artifactId>
    <version>v1.0.3</version>
</dependency>

3 API

3.1 参数校验注解

参数校验注解除了 spring-boot-starter-validation 中的注解外，还包含本项目自己实现的注解。

3.1.1 @EnumValid

对入参实体的参数做枚举值校验，如果传入的参数不再枚举范围内，则抛出异常。需要注意的是，注解会通过枚举类中的getter方法获取要校验的枚举值，默认方法名是getCode,也可以通过注解的getter属性指定枚举类中的方法。

@EnumValid(clazz = GenderEnum.class, message = "gender: 超出枚举值范围")
private Integer gender;

3.1.2 @MobileValid

校验手机号码格式，不过多介绍。

@MobileValid(message = "mobile: 手机号码格式不正确")
private String mobile;

3.2 工具类注解

3.2.1 @ServiceParamValid

方法参数非空校验。如果参数是个对象，可以校验对象中的属性。

1. 校验参数

   @ServiceParamValid("user")
   public void addUser(User user){
       // ...
   }
   

2. 校验对象中的参数

   @ServiceParamValid({"name", "gender"})
   public void addUser(User user){
       // ...
   }
   

3.2.2 @ServiceParamLog

用于打印方法的入参和出参日志。

@ServiceParamLog
public void addUser(User user){
    // ...
}

3.3 工具类

3.3.1 StrUtil

该类继承了 Hutool 的 StrUtil 类，并额外实现了一些方法。

方法	描述	示例
format	字符串模板，{}模板语法	StrUtil.replace("I am {}, age: {}", name, age);
toString	Set 集合转字符串