重庆分公司
重庆分公司，新征程启航
为企业提供网站建设、域名注册、服务器等服务
[Springcloud一步步实现广告系统]4.通用代码模块设计
一个大的系统，在代码的复用肯定是必不可少的，它能解决：
我们提供的服务有：网站制作、成都做网站、微信公众号开发、网站优化、网站认证、石河子ssl等。为近千家企事业单位解决了网站和推广的问题。提供周到的售前咨询和贴心的售后服务，是有科学管理、有技术的石河子网站制作公司
- 统一的响应处理（可以对外提供统一的响应对象包装）
![[Spring cloud 一步步实现广告系统] 4. 通用代码模块设计](/upload/otherpic51/228223.jpg)
- 统一的异常处理（可以将业务异常统一收集处理）
![[Spring cloud 一步步实现广告系统] 4. 通用代码模块设计](/upload/otherpic51/228227.jpg)
- 通用代码定义、配置定义（通用的配置信息放在统一的代码管理中，便于维护和更新）
创建项目
mscx-ad-common
POM文件
mscx-ad
com.sxzhongf
1.0-SNAPSHOT
../pom.xml
4.0.0
jar
com.sxzhongf
mscx-ad-common
1.0-SNAPSHOT
Common-Service
公共逻辑 and 帮助类
org.springframework.boot
spring-boot-starter-web
com.alibaba
fastjson
1.2.58
commons-codec
commons-codec
org.apache.commons
commons-lang3
org.springframework.boot
spring-boot-maven-plugin
项目结构
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
- Before(方法执行前)
- annotation
- config
- exception
- utils
- export
通用响应编码
- 创建通用返回对象
/**
* @Data是下属注解的组合注解
*
* @see Getter
* @see Setter
* @see RequiredArgsConstructor
* @see ToString
* @see EqualsAndHashCode
* @see lombok.Value
*/
@Data
@NoArgsConstructor //无参构造函数
@AllArgsConstructor //全参构造函数
public class CommonResponse 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;
}
} - 在advice包中实现对响应的统一拦截
com.sxzhongf.ad.common.advice.CommonResponseDataAdvice,参考 ResponseBodyAdvice,RestControllerAdvice可查看源码org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice
@RestControllerAdvice
public class CommonResponseDataAdvice implements ResponseBodyAdvice我们在annotation包下面添加一个注解com.sxzhongf.ad.common.annotation.IgnoreResponseAdvice,用它来标柱是否需要支持上面的统一返回拦截。
/**
* IgnoreResponseAdvice for 标示需要忽略拦截动作
*
* @author Isaac.Zhang
*/
//ElementType.TYPE 表示该注解可用于class
//ElementType.METHOD 表示可用于方法
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface IgnoreResponseAdvice {
}通用异常处理
异常处理也是统一的，那么同样就要使用到
RestControllerAdvice，同时，需要使用的Spring 的ExceptionHandler进行异常处理
- 创建统一异常拦截类
/**
* GlobalExceptionAdvice for 全局统一异常拦截
*
* @author Isaac.Zhang
* @see RestControllerAdvice
* @see ExceptionHandler
*/
@RestControllerAdvice
public class GlobalExceptionAdvice {
/**
* 对 {@link AdException} 进行统一处理
* {@link ExceptionHandler} 对指定的异常进行拦截
* 可优化：
* 定义多种类异常，实现对应的异常处理，
* 例如：
*
* -
* 推广单元操作异常，抛出 AdUnitException
*
* -
* Binlog 解析异常，抛出 BinlogException
*
*
* 拦截Spring Exception 使用 {@link ExceptionHandler}注解
*/
@ExceptionHandler(value = AdException.class)
public CommonResponse handlerAdException(HttpServletRequest request, AdException ex) {
CommonResponse response = new CommonResponse<>(-1, "business error");
response.setData(ex.getMessage());
return response;
}
} - 创建通用异常类
/**
* AdException for 统一异常处理类
*
* @author Isaac.Zhang
*/
public class AdException extends Exception {
public AdException(String message) {
super(message);
}
}通用配置信息
通过HTTP消息转换器HttpMessageConverter，实现对象转换，Java Object -> HTTP 数据流
- 新增
WebConfiguration,我们通过实现org.springframework.web.servlet.config.annotation.WebMvcConfigurer来定制和修改Spring MVC的配置信息。
/**
* WebConfiguration for 对Spring的配置和行为进行定制修改
*
* @author Isaac.Zhang
* @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 resolvers) {
}
/**
* 配置消息转换器
*/
@Override
public void configureMessageConverters(List> converters) {
//清空所有转换器
converters.clear();
// Java Obj -> Json Obj (http header: application/json)
converters.add(new MappingJackson2HttpMessageConverter());
}
} 网站标题：[Springcloud一步步实现广告系统]4.通用代码模块设计
标题链接：http://cqcxhl.cn/article/gcspjd.html