[Spring cloud 一步步實現廣告系統] 4. 通用代碼模塊設計

一個大的系統，在代碼的復用肯定是必不可少的，它能解決：

1. 統一的響應處理（可以對外提供統一的響應對象包裝）

2. 統一的異常處理（可以將業務異常統一收集處理）

3. 通用代碼定義、配置定義（通用的配置信息放在統一的代碼管理中，便于維護和更新）

創建項目mscx-ad-common

POM文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>mscx-ad</artifactId>
        <groupId>com.sxzhongf</groupId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <packaging>jar</packaging>

    <groupId>com.sxzhongf</groupId>
    <artifactId>mscx-ad-common</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>Common-Service</name>
    <description>公共邏輯 and 幫助類</description>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- fastjson是阿里巴巴的開源JSON解析庫，它可以解析JSON格式的字符串，支持將Java Bean序列化為JSON字符串，也可以從JSON字符串反序列化到JavaBean -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.58</version>
        </dependency>
        <!--  -->
        <dependency>
            <groupId>commons-codec</groupId>
            <artifactId>commons-codec</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
        </dependency>
    </dependencies>
        <!--maven編譯插件-->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

項目結構

• vo (統一響應對象package)

• advice (bean 增強package )

  Spring支持五種類型的增強或通知(Advice)

  • Before(方法執行前) org.apringframework.aop.MethodBeforeAdvice
  • AfterReturning(方法返回后) org.springframework.aop.AfterReturningAdvice
  • After-throwing(異常拋出后) org.springframework.aop.ThrowsAdviceArround環繞，即方法前后 org.aopaliance.intercept.MethodInterceptor
    引介，不常用 org.springframework.aop.IntroductionInterceptor
    具體可參考：細說advice,advisor

• annotation
• config
• exception
• utils
• export

  通用響應編碼

1. 創建通用返回對象

/**
* @Data是下屬注解的組合注解
* 
* @see Getter
* @see Setter
* @see RequiredArgsConstructor
* @see ToString
* @see EqualsAndHashCode
* @see lombok.Value 
*/
@Data
@NoArgsConstructor //無參構造函數
@AllArgsConstructor //全參構造函數
public class CommonResponse<T> implements Serializable {
   private Integer code = 0;
   private String message = "success";
   /**
    * 具體的數據對象信息
    */
   private T data;

   public CommonResponse(Integer code, String message) {
       this.code = code;
       this.message = message;
   }

   public CommonResponse(T data) {
       this.data = data;
   }
}

2. 在advice包中實現對響應的統一攔截com.sxzhongf.ad.common.advice.CommonResponseDataAdvice,參考 ResponseBodyAdvice, RestControllerAdvice 可查看源碼org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice

   @RestControllerAdvice
   public class CommonResponseDataAdvice implements ResponseBodyAdvice<Object> {

       /**
        * 判斷是否需要對響應進行處理
        *
        * @return false -> 不處理，true -> 處理
        */
       @Override
       public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> converterType) {
   //
   //        //獲取當前處理請求的controller的方法
   //        String methodName = methodParameter.getMethod().getName().toLowerCase();
   //        // 不攔截/不需要處理返回值 的方法
   //        String method = "login"; //如登錄
   //        //不攔截
   //        return !method.equals(methodName);

           // 如果類上標記了@IgnoreResponseAdvice，則不攔截
           if (methodParameter.getDeclaringClass().isAnnotationPresent(IgnoreResponseAdvice.class)) {
               return false;
           }

           // 如果方法上標記了@IgnoreResponseAdvice，則不攔截
           if (methodParameter.getMethod().isAnnotationPresent(IgnoreResponseAdvice.class)) {
               return false;
           }

           //對響應進行處理，執行beforeBodyWrite方法
           return true;
       }

       /**
        * 目的 攔截CommonResponse
        *
        * @param body 原始的Controller需要返回的數據
        */
       @Override
       public Object beforeBodyWrite(Object body, MethodParameter returnType,
                                     MediaType selectedContentType,
                                     Class<? extends HttpMessageConverter<?>> selectedConverterType,
                                     ServerHttpRequest request,
                                     ServerHttpResponse response) {

           CommonResponse<Object> commonResponse = new CommonResponse<>();

           if (null == body) {
               return commonResponse;
           } else if (body instanceof CommonResponse) {
               commonResponse = (CommonResponse<Object>) body;
           } else {
               commonResponse.setData(body);
           }
           return commonResponse;
       }
   }

我們在annotation包下面添加一個注解com.sxzhongf.ad.common.annotation.IgnoreResponseAdvice,用它來標柱是否需要支持上面的統一返回攔截。

   /**
    * IgnoreResponseAdvice for 標示需要忽略攔截動作
    *
    * @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang</a>
    */
   //ElementType.TYPE 表示該注解可用于class
   //ElementType.METHOD 表示可用于方法
   @Target({ElementType.TYPE, ElementType.METHOD})
   @Retention(RetentionPolicy.RUNTIME)
   public @interface IgnoreResponseAdvice {
   }

通用異常處理

異常處理也是統一的，那么同樣就要使用到RestControllerAdvice，同時，需要使用的Spring 的ExceptionHandler進行異常處理

1. 創建統一異常攔截類

/**
 * GlobalExceptionAdvice for 全局統一異常攔截
 *
 * @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang</a>
 * @see RestControllerAdvice
 * @see ExceptionHandler
 */
@RestControllerAdvice
public class GlobalExceptionAdvice {

    /**
     * 對 {@link AdException} 進行統一處理
     * {@link ExceptionHandler}  對指定的異常進行攔截
     * 可優化：
     * 定義多種類異常，實現對應的異常處理，
     * 例如：
     * <ul>
     * <li>
     * 推廣單元操作異常，拋出 AdUnitException
     * </li>
     * <li>
     * Binlog 解析異常，拋出 BinlogException
     * </li>
     * </ul>
     * 攔截Spring Exception 使用 {@link ExceptionHandler}注解
     */
    @ExceptionHandler(value = AdException.class)
    public CommonResponse<String> handlerAdException(HttpServletRequest request, AdException ex) {
        CommonResponse<String> response = new CommonResponse<>(-1, "business error");
        response.setData(ex.getMessage());
        return response;
    }
}

2. 創建通用異常類

/**
 * AdException for 統一異常處理類
 *
 * @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang</a>
 */
public class AdException extends Exception {
    public AdException(String message) {
        super(message);
    }
}

通用配置信息

通過HTTP消息轉換器HttpMessageConverter，實現對象轉換，Java Object -> HTTP 數據流

1. 新增WebConfiguration,我們通過實現org.springframework.web.servlet.config.annotation.WebMvcConfigurer來定制和修改Spring MVC的配置信息。

/**
 * WebConfiguration for 對Spring的配置和行為進行定制修改
 *
 * @author <a href="mailto:magicianisaac@gmail.com">Isaac.Zhang</a>
 * @see WebMvcConfigurer
 */
@Configuration
public class WebConfiguration implements WebMvcConfigurer {
    /**
     * 匹配路由請求規則
     */
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {

    }
    /**
     * 注冊自定義的Formatter 和 Convert
     */
    @Override
    public void addFormatters(FormatterRegistry registry) {

    }
    /**
     * 添加靜態資源處理器
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {

    }
    /**
     * 添加自定義視圖控制器
     */
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {

    }
    /**
     * 添加自定義方法參數處理器
     */
    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {

    }
    /**
     * 配置消息轉換器
     */
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        //清空所有轉換器
        converters.clear();
        // Java Obj -> Json Obj (http header: application/json)
        converters.add(new MappingJackson2HttpMessageConverter());
    }
}