当前位置：首页 > news >正文

基于SpringCloud的广告系统设计与实现（二）

news 来源：原创 2025/6/12 19:39:42

一、common公共模块

1.common的作用

通用的代码、配置不应该散落在各个业务模块中，不利于维护与更新
一个大的系统，响应对象需要统一外层格式
各种业务设计与实现，可能会抛出各种各样的异常，异常信息的收集也应该做到统一

2.统一响应

提供统一响应的好处主要有两点：

1. 与前端和客户端保持统一，拥有统一的结构，方便前端和客户端的统一处理，特别是在程序出错的情况下，可以直接显示错误信息。
2. 日志结构的统一，我们经常会把程序的响应以日志的形式打印出来，所以。响应是统一的，日志的结构也能够保持统一。

统一响应的代码说明

@RestControllerAdvice 注解

Advice 在 Spring 中的含义就是对 XX 功能增强，RestControllerAdvice（ControllerAdvice）就是对控制器增强。之所以使用 RestControllerAdvice，是因为我们对外提供的都是 Rest 接口（json）。

我们需要对 Controller 返回的内容做一些额外的工作，即功能增强，就需要利用到这个注解。另外，这个注解提供了 basePackages 属性可以指定对特定 package 中的 Controller 生效。

ResponseBodyAdvice 接口

ResponseBodyAdvice 的作用是在响应体返回之前做一些自定义的处理工作。通常，我们会实现 ResponseBodyAdvice 接口，并包装统一的响应返回。接口的详细定义可以阅读 Spring 官网的解释: Spring ResponseBodyAdvice

supports 方法

supports 的返回值是 boolean 类型，用于指定哪些 Controller 方法需要处理。我们当前的代码实现是标注了 IgnoreResponseAdvice 注解的类或者方法，统一响应不会生效。代码解释如下：

/*** <h2>判断是否需要对响应进行处理</h2>* @return false: 不需要处理; true: 需要处理* */
@Override
@SuppressWarnings("all")
public boolean supports(MethodParameter methodParameter,Class<? extends HttpMessageConverter<?>> aClass) {// 如果当前方法所在的类标识了 IgnoreResponseAdvice 注解, 则不需要处理if (methodParameter.getDeclaringClass().isAnnotationPresent(IgnoreResponseAdvice.class)) {return false;}// 如果当前方法标识了 IgnoreResponseAdvice 注解, 则不需要处理if (methodParameter.getMethod().isAnnotationPresent(IgnoreResponseAdvice.class)) {return false;}// 对响应进行处理, 执行 beforeBodyWrite 方法return true;
}

beforeBodyWrite 方法

根据方法的名字可以知道，这个方法实现了在结果输出前的操作。这个方法的参数很多，我们只需要关注第一个：Object，这个就是原始的 Controller 返回的内容。我们也就是需要对它进行包装。代码解释如下：

/*** <h2>响应返回之前的处理</h2>* @param o 响应对象* */
@Nullable
@Override
@SuppressWarnings("all")
public Object beforeBodyWrite(@Nullable Object o,MethodParameter methodParameter,MediaType mediaType,Class<? extends HttpMessageConverter<?>> aClass,ServerHttpRequest serverHttpRequest,ServerHttpResponse serverHttpResponse) {// 定义最终的返回对象CommonResponse<Object> response = new CommonResponse<>(0, "");// 如果 o 是 null, response 不需要设置 dataif (null == o) {return response;// 如果 o 已经是 CommonResponse 类型, 强转即可} else if (o instanceof CommonResponse) {response = (CommonResponse<Object>) o;// 否则, 把响应对象作为 CommonResponse 的 data 部分} else {response.setData(o);}return response;
}

如果我们对 Controller 返回的结果的处理过程比较复杂，那么根据处理的分类，可以指定多个 ResponseBodyAdvice，并使用 @Order 指定处理顺序。

3.统一异常

自定义异常是需要细化到具体的业务的，但是只有当你的某一块业务足够大（或者简单的说就是代码比较多）才需要自定义异常。比如代码中有很多处理推广计划的地方，就可以定义 AdPlanException；代码中处理 MySQL Binlog 的部分很多，就可以定义 MySQLBinlogException 等等

统一异常处理的解释说明

@ExceptionHandler

拦截 Spring 的异常处理需要使用到 ExceptionHandler 注解。Spring 3.0 引入的这个注解可以让我们在一个 handler 方法或者类中统一处理 Controller 抛出的异常，使得写出的代码更加清晰。

首先，来看看对这个注解的解释：

@Target(ElementType.METHOD)             // 这个注解标注在对象的方法上
@Retention(RetentionPolicy.RUNTIME)     // 在运行时有效
@Documented
public @interface ExceptionHandler {/*** Exceptions handled by the annotated method. If empty, will default to any* exceptions listed in the method argument list.* value 是一个 Class 数组，用于指定需要拦截的异常类。*/Class<? extends Throwable>[] value() default {};
}

说明：该注解注释的方法可以有灵活的输入参数，通常需要给出异常参数：包括一般的异常或特定的异常（即自定义异常），如果注解自身没有指定异常类，会默认进行映射。

/*** <h1>全局异常处理</h1>* RestControllerAdvice: 组合注解, ControllerAdvice + ResponseBody, 是对 RestController 的功能增强* Created by Qinyi.*/
@RestControllerAdvice
public class GlobalExceptionAdvice {/*** <h2>对 AdException 进行统一处理</h2>* ExceptionHandler: 可以对指定的异常进行拦截* 优化: 定义多种类异常, 并实现对应的异常处理. 例如: 推广单元的操作出现异常, 抛出 AdUnitException;*  Binlog 解析异常, 抛出 BinlogException* */@ExceptionHandler(value = AdException.class)public CommonResponse<String> handlerAdException(HttpServletRequest req,AdException ex) {// 统一异常接口的响应// 优化: 定义不同类型的异常枚举(异常码和异常信息)CommonResponse<String> response = new CommonResponse<>(-1,"business error");response.setData(ex.getMessage());return response;}
}

4.统一配置开发

WebMvcConfigurer 接口

WebMvcConfigurer配置类其实是Spring内部的一种配置方式，采用JavaBean的形式来代替传统的xml配置文件形式进行针对框架个性化定制，可以自定义一些Handler，Interceptor，ViewResolver，MessageConverter。

Spring 的 WebMvcConfigurer 接口提供了很多方法让我们来定制 Spring MVC 的配置。这个接口还是非常常用的，可以对 Spring 的很多配置和行为进行定制。下面对一些常用的方法进行解释：

public interface WebMvcConfigurer {/*** 匹配路由请求规则*/default void configurePathMatch(PathMatchConfigurer configurer) {}/*** 注册自定义的 Formatter 和 Convert*/default void addFormatters(FormatterRegistry registry) {}/*** 添加静态资源处理器*/default void addResourceHandlers(ResourceHandlerRegistry registry) {}/*** 配置消息转换器*/default void configureMessageConverters(List<HttpMessageConverter<?>> converters) {}/*** 添加自定义视图控制器*/default void addViewControllers(ViewControllerRegistry registry) {}/*** 添加自定义方法参数处理器*/default void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {}
}

HTTP 消息转换器（HttpMessageConverter）是 Spring 框架中的一个核心组件，用于在 HTTP 请求和响应之间进行消息转换。它主要有两个作用：

将请求报文转化为 Java 对象
将 Java 对象转化为响应报文

主要方法

HttpMessageConverter 接口定义了以下方法：

getSupportedMediaTypes：获取支持的 MediaType 集合，如 text/html、text/plain、application/json 等。
canRead：判断是否能读（请求）。
read：将请求数据进行格式转换，当 canRead 方法返回值为 true 时调用。
canWrite：判断是否能写（响应）。
write：将响应数据进行格式转换，当 canWrite 方法返回值为 true 时调用。

默认配置的消息转换器

SpringMVC 启动时会自动配置一些 HttpMessageConverter，如：

ByteArrayHttpMessageConverter：负责读、写二进制格式数据。
StringHttpMessageConverter：负责读、写字符串格式数据。
ResourceHttpMessageConverter：负责读、写资源文件数据。
AllEncompassingFormHttpMessageConverter：负责读、写 Form 表单数据。
MappingJackson2HttpMessageConverter：负责读、写 JSON 格式数据（利用 Jackson）。
Jaxb2RootElementHttpMessageConverter：负责读、写 XML 格式数据（使用 JAXB）。

使用场景

在 SpringMVC 中，通过 @RequestBody 和 @ResponseBody 注解可以方便地使用 HttpMessageConverter。注意：@ResponseBody 只是 rest 请求的返回序列化注解，并不是消息转换器。

如果没有定义消息转换器，Spring MVC 将会使用自己的默认预定义好的消息转换器。

二、回顾Springboot特性

1.Spring IOC

@Autowire 和 @Resource，它们主要有两点区别：

1. @Autowire 是 Spring 开发的，而 @Resource 是 jdk 开发的

2. @Autowire 是按照 type 来注入的，而 @Resource 是按照名称来注入的，如果名称找不到，那么就按照 type。对于一个接口，如果有多个实现，那么就必须使用 @Resource 注入，并指定需要注入的实现类。

关于 @Autowire，它实现了依赖对象的自动装配，而自动装配的各个 Bean 都是在 Spring 容器启动时自动配置好的，并一直保持在 Spring 容器中。

Spring 中使用 @Repository、@Service、@Controller 和 @Component 将类标识为 Bean。下面，我对这几个注解做出说明：Spring 从 2.0 版本开始，陆续引入了一些注解用于简化 Spring 的开发。@Repository 注解便属于最先引入的一批，它用于将数据访问层 (DAO 层 ) 的类标识为 Spring Bean。Spring 2.5 在 @Repository 的基础上增加了功能类似的额外三个注解：@Component、@Service、@Controller，它们分别用于软件系统的不同层次：

1. @Component 是一个泛化的概念，仅仅表示一个组件 (Bean) ，可以作用在任何层次；

2. @Service 通常作用在业务层，但是目前该功能与 @Component 相同；

3. @Constroller 通常作用在控制层，但是目前该功能与 @Component 相同。

通过在类上使用 @Repository、@Component、@Service 和 @Controller 注解，Spring 会自动创建相应的 BeanDefinition 对象，并注册到 ApplicationContext 中。

最后，我们来看下 @Configuration 注解，它的定义如下：

@Target({ElementType.TYPE})

@Retention(RetentionPolicy.RUNTIME)

@Documented

@Component

public @interface Configuration {

String value() default "";

}

因为 @Configuration 注解本身定义时被 @Component 标注了。因此可以说，一个 @Configuration 同时也是一个 @Component。这个注解是用在配置类上的，我们需要在配置信息的类上加上 @Configuration 注解，以明确指出该类是 Bean 配置的信息源。

综上所述：XXX类中的 @Configuration 是不可以换成 @Service 的。

2.Spring MVC

3.Spring Boot常用功能

（1）SpringBoot应用启动入口

@SpringBootApplication 注解是一个组合注解，它集成了 @SpringBootConfiguration、@EnableAutoConfiguration 和 @ComponentScan 三个注解的功能。通过这个注解，Spring Boot 可以自动配置项目，扫描组件，并启用自动配置功能。这大大简化了 Spring Boot 应用程序的配置，使得开发者可以更专注于业务逻辑的实现。

注解组成：

@SpringBootApplication 是由以下三个注解组成的：

@SpringBootConfiguration：表示该类是一个配置类，相当于 Spring 中的 @Configuration。

以下类使用@Configuration：

为了在 Ribbon 使用的时候方便注入，如果没有注入到 Spring 容器中，不能直接使用 @Resource 注解。同时，如果你需要做特殊定制时，加上一些配置，没有的话，直接 new 一个放到容器中就可以。

一文搞懂springboot启动原理 - 简书

@EnableAutoConfiguration：启用 Spring Boot 的自动配置功能，Spring Boot 会根据添加的依赖自动配置项目。
@ComponentScan：启用组件扫描，Spring 会扫描指定包下的组件（如 @Controller、@Service、@Repository、@Component 等）。

注解属性：

exclude：用于排除不需要自动配置的类，例如 DataSourceAutoConfiguration.class。
excludeName：用于排除不需要自动配置的类的全限定名，例如 "org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration"。
scanBasePackages：指定组件扫描的包路径，例如 "com.mycompany.myapp"。
scanBasePackageClasses：指定组件扫描的包路径的类型安全版本，例如 MyApp.class，Spring 会扫描 MyApp.class 所在的包。

（2）容器启动之后执行的操作

在 Spring Boot 应用程序启动并完成容器初始化后，CommandLineRunner 和 ApplicationRunner 可以用于执行一些初始化操作。这两个接口的实现类会被 Spring Boot 自动检测并执行，它们在功能上非常相似，但在参数处理上有所不同。

CommandLineRunner 和 ApplicationRunner 都是 Spring Boot 提供的接口，用于在应用程序启动后执行初始化任务。

简单场景：如果只需要处理简单的命令行参数，使用 CommandLineRunner 更为简洁。
复杂场景：如果需要处理复杂的命令行参数，特别是包含选项和非选项参数的场景，使用 ApplicationRunner 更为合适。

如果同时使用 CommandLineRunner 和 ApplicationRunner，Spring Boot 会按照以下顺序执行它们：

ApplicationRunner：先执行 ApplicationRunner 的 run 方法。
CommandLineRunner：再执行 CommandLineRunner 的 run 方法。

（3）Profile 环境配置

读取配置文件：

一般项目，在不同阶段要使用不同的环境，一般包括开发、测试、正式环境，分成不同的文件application-{profile}.yml。在application.yml中合理设置环境配置：

active指定环境{profile}

Spring Boot 会按照以下顺序加载配置文件，后面的配置会覆盖前面的配置：

application.properties 或 application.yml(Spring Boot 会根据 spring.profiles.active 环境变量的值来激活相应的配置文件)
application-{profile}.properties 或 application-{profile}.yml
命令行参数
环境变量

读取配置实体化：

@ConfigurationProperties 注解

@ConfigurationProperties 是 Spring Boot 提供的一个注解，用于将外部配置文件（application.yml）中的属性绑定到 Java 对象上。通过使用这个注解，开发者可以将配置文件（如 application.properties 或 application.yml）中的属性值映射到应用程序的配置类中，以便在整个应用程序中方便地访问和使用这些属性。

创建一个普通的 Java 类（POJO），该类的属性将映射到配置文件中的属性。确保为属性提供适当的 getter 和 setter 方法。@ConfigurationProperties 并没有把当前类注册成为一个 Spring 的 Bean。所以，我们在使用时都会配合 @Component 注解直接进行注入。

配置文件中：

（4）定时任务

@Scheduled

@Scheduled 注解用于计划执行，它提供了多种参数控制执行的时间和频率等。例如：fixedRate 以固定的频率执行、cron 以 crontab 表达式的规则执行等等。

@Scheduled 任务是非常常用的，使用起来也非常简单：1. 加载到 Spring 容器中；2. 指定你想要的执行规则。例如：

@Component
public class ScheduledTask {// @Scheduled(fixedRate = 5000)         上一次开始执行时间点之后5秒再执行// @Scheduled(fixedDelay = 5000)        上一次执行完毕时间点之后5秒再执行// @Scheduled(cron = "*/5 * * * * *")   通过 crontab 表达式定义规则@Scheduled(fixedRate = 1000)public void helloSpringBoot() {System.out.println("Hello SpringBoot");}
}

在启动类中要配置@EnableScheduling，才会扫描到定时任务。