苍穹外卖中的模块总结

本文总结苍穹外卖项目中可复用的通用设计
sky-common

constant存放常量类，包罗消息常量，状态常量
context是上下文对象，封装了threadlocal

1. package com.sky.context;
3. public class BaseContext {
5.     public static ThreadLocal<Long> threadLocal = new ThreadLocal<>();
7.     public static void setCurrentId(Long id) {
8.         threadLocal.set(id);
9.     }
11.     public static Long getCurrentId() {
12.         return threadLocal.get();
13.     }
15.     public static void removeCurrentId() {
16.         threadLocal.remove();
17.     }
19. }

复制代码

enumeration存放枚举类
exception存放自定义异常类，用于抛出自定义异常

1. /**
2. * 业务异常
3. */
4. public class BaseException extends RuntimeException {
6.     public BaseException() {}
7.     public BaseException(String msg) {
8.         super(msg);
9.     }
11. }

复制代码

1. /**
2. * 账号被锁定异常
3. */
4. public class AccountLockedException extends BaseException {
6.     public AccountLockedException() {
7.     }
9.     public AccountLockedException(String msg) {
10.         super(msg);
11.     }
13. }

复制代码

properties用于配置工具类的属性,@ConfigurationProperties(prefix = “sky.alioss”)读取application.yml中以sky.alioss为前缀的具体值

1. @Component
2. @ConfigurationProperties(prefix = "sky.alioss")
3. @Data
4. public class AliOssProperties {
5.     private String endpoint;
6.     private String accessKeyId;
7.     private String accessKeySecret;
8.     private String bucketName;
9. }

复制代码

utils封装具体的工具类
result封装返回给前端的响应类
json封装对象映射器（基于jackson将Java对象转为json，大概将json转为Java对象），定制 JSON 与 Java 对象之间的序列化（对象转JSON）和反序列化（JSON转对象）规则
sky-pojo

entity封装实体类，dto封装前端向后端通报数据的对象，通常是entity中某个类的部分数据，vo封装后端向前端返回数据的对象，按照前端需要的数据格式进行设计
sky-server

annotation和aspect负责springboot的aop切面编程
config用于注册Bean
WebMvcConfiguration

1. /**
2. * 配置类，注册web层相关组件
3. */
4. @Configuration
5. @Slf4j
6. public class WebMvcConfiguration extends WebMvcConfigurationSupport {
8.     @Autowired
9.     private JwtTokenAdminInterceptor jwtTokenAdminInterceptor;
10.     @Autowired
11.     private JwtTokenUserInterceptor jwtTokenUserInterceptor;
13.     /**
14.      * 注册自定义拦截器
15.      *
16.      * @param registry
17.      */
18.     protected void addInterceptors(InterceptorRegistry registry) {
19.         log.info("开始注册自定义拦截器...");
20.         registry.addInterceptor(jwtTokenAdminInterceptor)
21.                 .addPathPatterns("/admin/**")
22.                 .excludePathPatterns("/admin/employee/login");
23.         registry.addInterceptor(jwtTokenUserInterceptor)
24.                 .addPathPatterns("/user/**")
25.                 .excludePathPatterns("/user/user/login")
26.                 .excludePathPatterns("/user/shop/status");
27.     }
29.     /**
30.      * 通过knife4j生成接口文档
31.      * @return
32.      */
33.     @Bean
34.     public Docket docket1() {
35.         ApiInfo apiInfo = new ApiInfoBuilder()
36.                 .title("苍穹外卖项目接口文档")
37.                 .version("2.0")
38.                 .description("苍穹外卖项目接口文档")
39.                 .build();
40.         Docket docket = new Docket(DocumentationType.SWAGGER_2)
41.                 .groupName("管理端接口")
42.                 .apiInfo(apiInfo)
43.                 .select()
44.                 .apis(RequestHandlerSelectors.basePackage("com.sky.controller.admin"))
45.                 .paths(PathSelectors.any())
46.                 .build();
47.         return docket;
48.     }
50.     @Bean
51.     public Docket docket2() {
52.         ApiInfo apiInfo = new ApiInfoBuilder()
53.                 .title("苍穹外卖项目接口文档")
54.                 .version("2.0")
55.                 .description("苍穹外卖项目接口文档")
56.                 .build();
57.         Docket docket = new Docket(DocumentationType.SWAGGER_2)
58.                 .groupName("用户端接口")
59.                 .apiInfo(apiInfo)
60.                 .select()
61.                 .apis(RequestHandlerSelectors.basePackage("com.sky.controller.user"))
62.                 .paths(PathSelectors.any())
63.                 .build();
64.         return docket;
65.     }
67.     /**
68.      * 设置静态资源映射
69.      * @param registry
70.      */
71.     protected void addResourceHandlers(ResourceHandlerRegistry registry) {
72.         registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
73.         registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
74.     }
76.     /**
77.      * 扩展spring mvc 的消息转换器
78.      * @param converters
79.      */
80.     @Override
81.     protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
82.         log.info("扩展消息转换器");
83.         //创建一个消息转换器对象
84.         MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
85.         //为消息转换器设置一个对象转换器，对象转换器可将java对象序列化
86.         converter.setObjectMapper(new JacksonObjectMapper());
87.         //将消息转换器添加到converters
88.         converters.add(0,converter);
91.     }
93. }

复制代码

z

1. public class OssConfiguration {
3.     @Bean
4.     @ConditionalOnMissingBean
5.     public AliOssUtil aliOssUtil(AliOssProperties aliOssProperties) {
6.         log.info("开始创建阿里云上传文件工具类对象",aliOssProperties);
7.         return new AliOssUtil(aliOssProperties.getEndpoint(),
8.                 aliOssProperties.getAccessKeyId(),
9.                 aliOssProperties.getAccessKeySecret(),
10.                 aliOssProperties.getBucketName()
11.         );
12.     }
13. }

复制代码

这里用到前面common中提到的AliOssProperties来创建AliOssUtil类
handle用于定义全局异常处理器，处理各个地方抛出的异常

1. /**
2. * 全局异常处理器，处理项目中抛出的业务异常
3. */
4. @RestControllerAdvice
5. @Slf4j
6. public class GlobalExceptionHandler {
8.     /**
9.      * 捕获业务异常
10.      * @param ex
11.      * @return
12.      */
13.     @ExceptionHandler
14.     public Result exceptionHandler(BaseException ex){
15.         log.error("异常信息：{}", ex.getMessage());
16.         return Result.error(ex.getMessage());
17.     }
19.     @ExceptionHandler
20.     public Result exceptionHandler(SQLIntegrityConstraintViolationException ex){
21.         String msg=ex.getMessage();
22.         if(msg.contains("Duplicate entry")){
23.             String[] msgs=msg.split(" ");
24.             String username=msgs[2];
25.             return Result.error(username+MessageConstant.ALREADY_EXISTS);
26.         }else{
27.             return Result.error(MessageConstant.UNKNOWN_ERROR);
28.         }
29.     }
31. }

复制代码

@RestControllerAdvice:表示这是一个全局异常处理类，会拦截所有 @RestController 或 @Controller 抛出的异常，并将处理效果以 JSON 格式返回给前端。
@ExceptionHandler :是 Spring 框架中用于集中处理异常的焦点注解，它的焦点作用是捕捉并处理控制器（Controller）中抛出的特定异常，返回同一的错误响应。
interceptor用于定义拦截器
task定义定时任务类，与websocket共同使用

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。