README.md

myhelper-spring-boot-starter

一个用于简化开发的sprint-boot-starter项目，暂且把它命名为myhelper吧

作者：ye17186，博客地址：IT小跟班

内置工具类：

1. DateUtils：时间工具类，用于处理时间，包括JDK8中的时间
2. IdGenUtils：ID生成工具类，用于生成全局唯一的ID，内置了基于SnowFlake算法的分布式ID生成策略
3. JsonUtils：Json格式化工具类，基于Jackson的json处理
4. RedisUtils：Redis操作工具类，封装了普通Object、Set、List、Map多种对象的处理方法
5. StringUtils：字符串工具类，扩展至org.apache.commons.lang3.StringUtils，提供常用的字符串处理方法
6. SpringUtils：Spring上下文工具类，封装了一套静态方法，用于随时随地的取出Spring上下文中的Bean对象
7. ValidUtils：参数校验工具类，用于手动校验参数的合法性

内置插件：

1. TokenPlugin 提供了基于token、timestamp、nonce、signature接口安全处理，此插件依赖于Redis 启用方式: myhelper.plugins.token.enabled=true
2. ControllerAdvicePlugin 提供了控制器的增强处理，用于统一异常处理 启用方式: myhelper.plugins.controller-advice.enabled=true
3. SwaggerPlugin 提供了Swagger在线文档功能，只需要在yml中简单配置，即可集成Swagger2 启用方式: myhelper.plugins.swagger.enabled=true

Web增强：

1. EnumValid、EnumValidator用于校验枚举类型的入参
2. ApiRes、ApiResp项目统一的入参及响应类型
3. StringToDateConverter等，字符串类型参数自动绑定后台Date、LocalDateTime类型
4. MethodLogPoint方法日志切面处理，基于AOP的方法级日志切面处理，可用来打印日志。 支持敏感参数脱敏，支持忽略方法返回结果，支持打印客户端信息（客户端IP等）
5. ApiAccessFilter过滤器，默认处理所有API，打印进入和离开日志，统计API耗时

Start

pom.xml加入MyHelper依赖

<dependency>
  <groupId>com.yclouds</groupId>
  <artifactId>myhelper-spring-boot-starter</artifactId>
  <version>2.1.1</version>
</dependency>

application.yml开启指定插件

myhelper:
  plugins:
    token:
      enabled: true
      secret-key: helloWorld
      valid-duration: 3600
    controller-advice:
      enabled: true
    swagger:
      enabled: true

MethodLogPoint使用

1. 配置MethodLog处理器，并通过@EnableMethodLog启用

@EnableMethodLog
@Configuration
public class MethodLogConfig implements MethodLogConfigurer {

    @Override
    public void afterReturn(MethodLogModel logModel) {

        log.info(JsonUtils.obj2Json(logModel));
    }

    @Override
    public void afterThrow(MethodLogModel logModel) {

        log.info(JsonUtils.obj2Json(logModel));
    }
}

2. 日志记录

@MethodLogPoint(action = "demo", sensitiveParams = "password1", includeRequest = true)
@RequestMapping("/demo")
public ApiResp demo() {

    return ApiResp.retOK();
}

ApiAccessFilter使用

@SpringBootApplication
@EnableApiAccessFilter
public class DemoAsyncApplication {
  ...
}