hunter-spring-boot-starter

提供以下内置工具和对象

1. 通用返回类Result
2. 全局异常处理
3. Jackson工具类
4. StringUtil工具
5. Redis工具类
6. RestTemplate工具类
7. 线程池自动装配
8. swagger 自动装配

9. DefaultWebMVC注解自动装配web项目

依赖

1. 所需依赖：springboot-starter、springboot-starter-web

2. 包含依赖：

   项目已经包含了这些依赖，无需重复引入。

   依赖	描述
   commons-lang3	apache工具
   commons-lang	工具集
   lombok	简化代码
   guava	googlet提供的工具

快速开始

1. 引入上述所需的依赖包

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

1. 引入本项目

     
      com.github.gxhunter
         
     
      hunter-spring-boot-starter
         
     
      0.6
     

功能描述

介绍本starter提供的一些通用工具、自动化装配方案等。

通用返回类com.github.gxhunter.vo.Result

• 描述
  在企业开发中，Controller一般需要返回通用的一个对象，一般包含status（返回码）、data（数据）、message（提示信息），这里提供了我本人常用的一个通用Result解决方案
  • 字段描述

字段	返回值	描述
status	int	状态码
message	string	返回信息
data	T	携带数据
success	boolean	是否成功

• 静态方法

方法名称	描述
success(T data)	成功并返回数据
success()	成功不携带数据
successMsg(String msg)	成功并返回信息
failed(String str)	失败，并提示信息，code使用默认
failed(T data,IErrorCode code)	失败，携带数据和提示信息和code
failed(T data,String message)	失败，并携带数据和提示信息

failed()|失败，不携带信息

## Jackson工具类 com.github.gxhunter.util.JsonUtil

• 描述

  Jackson是spring默认的json序列化工具，但是与fastjson不同，没有内置很方便的方法可以在对象和javabean之间互转，大多数情况你可能会考虑fastjson作为json工具类，但这样有个问题，Jackson的注解在fastjson不再适用，为了解决这个问题，你可能还要侵入式地添加fastjson的注解。
  在同一个项目使用两个json工具也是不提倡的做法，所以这里提供了一个Jackson的封装工具JsonUtil。

• 默认配置

  ```$xslt
  static{
  //只序列化不为null的字段
  objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
  //取消默认转换timestamps形式
  objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,false);
  //忽略空Bean转json的错误
  objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS,false);
  //忽略 在json字符串中存在，但是在java对象中不存在对应属性的情况。防止错误
  objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES,false);
  }

* 静态方法    1. 对象转为Json字符串    ```$xslt    /**     * 对象转json     */    public static 
     
       String toJSON(T obj)    ```    2. 对象转为json数组    ```$xslt    /**     * 对象转json     */    public static 
      
        String toJSON(T obj)    ```    3. JSON转为java对象    ```$xslt    /**     * JSON转为java对象     * @param str   json字符串     * @param clazz java对象类型     * @param 
       
           java对象类型     * @return     */    public static 
        
          T parse(String str,Class
         
           clazz)    ```## Redis工具类com.github.gxhunter.service.IRedisClient基于Resttemplate做的二次封装引入spring-boot-data-redis-starter即可使用## restTemplate* 使用okhttp代替默认的httpclient作为底层实现* 具体配置    在yml中    ```    hunter:        spring:                rest:                readTimeout: 读取超时(默认：5000ms)                connectTimeout: 连接超时(默认：3000ms)                writeTimeout: 写入超时(默认：5000ms)    ```    ## 线程池在yml中配置（可选）```$xslthunter:    spring:         thread-pool:        core-pool-size: 默认20 池中所保存的线程数，包括空闲线程。        maximum-pool-size: 默认100 池中允许的最大线程数。        keep-alive-time: 默认30 当线程数大于核心时，此为终止前多余的空闲线 程等待新任务的最长时间。
         
        
       
      
     

使用

@Autowiredprivate ThreadPoolExecutor mPoolExecutor;

swagger 支持

• 描述
  开发中，我们一般需要swagger来自动生成restapi文档，省去了在postman填写各类参数和url的麻烦，而swagger2官方目前并没有提供自动化装配starter，为了使用swagger2，你不得不编写bean和configuration，为了解决这个繁琐的问题本starter提供了swagger2的自动化装配。

1. 在pom中引入相关依赖，如

         
      
       com.github.xiaoymin
          
      
       swagger-bootstrap-ui
          
      
       1.8.6
      
     
         
      
       io.springfox
          
      
       springfox-swagger2
          
      
       2.9.2
      
     

建议结合swagger-bootstart-ui使用

1. 在yml中做相关配置,如

hunter:    spring:        swagger:        base-package: 扫描路径        version: 版本        description: 详细信息        license: 授权协议        title: 标题        license-url: 授权协议url        host: 127.0.0.1        enabled: 是否开启，默认为false 关闭        contact:            email: 开发者邮箱            name: 开发者名称            url: 开发者url

返回码枚举

com.github.gxhunter.enums.ResultEnum

内置返回码对照表

遵循COC原则，内置了几个返回码枚举，你也可以实现IResponseCode.java自定义扩展

内置的返回码枚举在com.github.gxhunter.enums.ResultEnum

返回码	描述
0	成功
1000	操作失败（一般是抛出服务端手段throw ApiException）
1001	参数校验失败
1999	网络超时（上述之外的其他异常）

修改默认返回码

如果你不想使用默认的返回码，那么可以在你的resource目录下新建一个response-code.properties文件，配置如下

SUCCESS=成功时返回码DEFAULT_ERROR=默认错误返回码METHOD_ARGUMENT_VALID_FAIL=方法校验失败返回码UNKNOW_ERROR=其他错误返回码

• 注意：如果你的项目下包含了response-code.properties文件，那么上述所有字段都必须配置，不能只配置其中几个！

扩展

默认提供的ResultEnum只是最基础的几个情况，可能无法满足覆盖业务需求，你可以编写一个枚举继承com.github.gxhunter.enums.IResponseCode实现扩展。

@DefaultWebMVC

• 默认配置一些Javabean的序列化与反序列化格式、时区、过滤的url

• 使用方法：再启动类加上 @DefaultWebMVC注解

  1. json与java互转格式
  java对象	json对象
  Date	yyyy-MM-dd HH:mm:ss
  LocalDateTime	yyyy-MM-dd HH:mm:ss
  LocalDate	yyyy-MM-dd
  LocalTime	HH:mm:ss
  Long	string
  null	不序列化

  配置时区为GMT+8

  1. 不拦截swagger相关url
  2. 添加此注解后开启了默认异常处理，捕获服务端的异常，分类返回给前端，具体看下一节

全局异常处理器 com.github.gxhunter.exception

• 描述
  在企业项目中，后端的错误不能把具体异常抛给前端，需要做异常捕获、分类等。并且根据异常类型返回不同的错误码（通用返回类Result中的status），
  这里默认捕获了所有异常，并对常见的几个异常做分类，使之返回不同的status。

• 启用方法

  在启动类加上@DefaultWebMVC注解即可

• 分类捕获的异常

  1. ApiException

     自定义的异常，由后端手动抛出，再被异常处理器捕获，把具体信息[code]返回给前端，比如你在java中这样写
     throw new ApiException("服务端抛出异常");
     前端接收到的结果：
     {    status:1000,    message:"服务端抛出异常",    success: false}

  2. MethodArgumentNotValidException

     服务端使用jsr303注解作参数校验,校验不通过时，会自动抛出MethodArgumentNotValidException异常，异常处理器捕获了这类校验异常，把校验失败的原因、字段返回给前端，校验失败的status为1001
     {      "status": "1001",      "message": "参数校验失败",      "data": {        "校验失败的字段": "失败原因",      },      "success": false    }

  3. Exception

     其他异常没有被分类，统一返回一下1999状态码
     {      "status": "1999",      "message": "网络超时",      "success": false    }

• 关闭异常处理器

  不想使用内置的异常处理器，或者内置的异常处理器不能满足你的业务需求，

  两种可选方式可以关闭默认的异常处理器， 任选其一
  1. 在yml中配置

     hunter:    spring:    #      是否开启内置异常处理器        exceptionResolver: true

  2. 去除@DefaultWebMVC注解

待续...