spring boot3多模块项目工程搭建-下(团队开发模板)
在上一篇文章中,我们已经搭建了一个基础的Spring Boot 3多模块项目。在这篇文章中,我们将继续完善这个项目,增加一些团队开发中常用的配置和工具类。
- 添加Swagger配置
在trade-common
模块中添加Swagger的依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
然后在trade-common
模块中创建一个Swagger配置类:
package com.example.trade.common.config;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class SwaggerConfig {
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.info(new Info()
.title("示例项目API文档")
.version("v1.0.0")
.license(new License().name("Apache 2.0").url("http://springdoc.org")));
}
}
- 添加统一异常处理
在trade-common
模块中添加统一异常处理的类:
package com.example.trade.common.exception;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(Exception.class)
public ResponseEntity<String> handleException(Exception e) {
// 这里只是简单处理,实际项目中应根据不同异常类型进行更详细的处理
return new ResponseEntity<>("An error occurred: " + e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
}
}
- 添加全局配置属性
在trade-common
模块中添加配置属性类:
package com.example.trade.common.config;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
private String name;
private String version;
// standard getters and setters
}
然后在application.properties
或application.yml
中添加配置:
app.name=示例项目
app.version=1.0.0
- 添加日志配置
在trade-common
模块中添加日志配置文件\`logback-s
评论已关闭