一. 项目初始化
在开发一个新项目之前,先下载IDE,虽然有诸多限制,但IDE必须还得用啊,官方提供了社区版,很多同学用着社区版,还有一部分同学继续走着破解之路。
接下来咱们先看看如何用IDE创建springboot项目,然后一路next就行了
这就是刚创建好的项目,新鲜出炉,有启动类、配置文件、测试启动类。
二. 版本管理
咱们的项目就这么轻松的创建成功了,是不是可以上手开发了,先别着急。先给你看个东西。
这是springCloud和springboot版本之间的对应关系:spring.io/projects/sp…https://link.juejin.cn/?target=https%3A%2F%2Fspring.io%2Fprojects%2Fspring-cloud
这是springboot和kafka的版本对应关系:spring.io/projects/sp…
https://link.juejin.cn/?target=https%3A%2F%2Fspring.io%2Fprojects%2Fspring-kafka
有一款神器不是叫Maven吗,这个不就是解决版本之间的依赖关系吗?
在说maven之前,先简单说一下springboot的自动配置,在springboot出来之前,大家依赖关系都是通过手动添加,springboot的autoconfiuration功能解决了包之间依赖关系,至少让研发的开发效率提升了50%,但有些场景下依赖的冲突还是未能解决。
Maven – Welcome to Apache Maven
Apache Maven is a software project management and comprehension tool
我们最常用的maven命令是build,package,在构建上真的是一把利器,maven确实提升了研发的效率。
三. 工程代码结构
接下来我们来看看都有哪些核心类,我把代码贴到下方。
全局异常处理 GlobalExceptionHandler
@RestControllerAdvice
@ResponseBody
@Slf4j
public class GlobalExceptionHandler {
@ExceptionHandler(value = {MethodArgumentNotValidException.class})
public ResponseResult<String> handleValidException(MethodArgumentNotValidException ex, HttpServletResponse httpServletResponse) {
log.error("[GlobalExceptionHandler][handleValidException] 参数校验exception", ex);
return wrapperBindingResult(ex.getBindingResult(), httpServletResponse);
}
private ResponseResult<String> wrapperBindingResult(BindingResult bindingResult, HttpServletResponse httpServletResponse) {
StringBuilder errorMsg = new StringBuilder();
for (ObjectError error : bindingResult.getAllErrors()) {
if (error instanceof FieldError) {
errorMsg.append(((FieldError) error).getField()).append(": ");
}
errorMsg.append(error.getDefaultMessage() == null ? "" : error.getDefaultMessage());
}
httpServletResponse.setStatus(HttpStatus.BAD_REQUEST.value());
return ResponseResult.failed(ResultCode.FAILED.getCode(),null);
}
日志处理 WebLogAspect
@Aspect
@Slf4j
@Component
public class WebLogAspect {
@Pointcut("@within(org.springframework.stereotype.Controller) || @within(org.springframework.web.bind.annotation.RestController)")
public void cutController() {
}
@Before("cutController()")
public void doBefore(JoinPoint point) {
//获取拦截方法的参数
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
String url = request.getRequestURL().toString();
List<Object> list = Lists.newArrayList();
for (Object object : point.getArgs()) {
if (object instanceof MultipartFile || object instanceof HttpServletRequest || object instanceof HttpServletResponse || object instanceof BindingResult) {
continue;
}
list.add(object);
}
log.info("请求 uri:[{}],params:[{}]", url, StringUtils.join(list, ","));
}
/**
* 返回通知:
* 1. 在目标方法正常结束之后执行
* 1. 在返回通知中补充请求日志信息,如返回时间,方法耗时,返回值,并且保存日志信息
* @param response
* @throws Throwable
*/
@AfterReturning(returning = "response", pointcut = "cutController()")
public void doAfterReturning(Object response) {
if (response != null) {
log.info("请求返回result:[{}]", JSONUtil.toJsonStr(response));
}
}
}
跨域类 GlobalCorsConfig
@Configuration
public class GlobalCorsConfig {
/**
* 允许跨域调用的过滤器
*/
@Bean
public CorsFilter corsFilter() {
CorsConfiguration config = new CorsConfiguration();
//允许所有域名进行跨域调用
config.setAllowedOrigins(Lists.newArrayList("*"));
//允许跨越发送cookie
config.setAllowCredentials(true);
//放行全部原始头信息
config.addAllowedHeader("*");
//允许所有请求方法跨域调用
config.addAllowedMethod("*");
UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
source.registerCorsConfiguration("/**", config);
return new CorsFilter(source);
}
}
@Configuration
@EnableOpenApi
public class SwaggerConfig {
@Bean
public Docket docket() {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo()).enable(true)
.select()
//apis: 添加swagger接口提取范围
.apis(RequestHandlerSelectors.basePackage("com.vines.controller"))
//.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("项目描述")
.description("基础服务项目描述")
.contact(new Contact("作者", "作者URL", "作者Email"))
.version("1.0")
.build();
}
}
响应体 ResponseResult
@Data
public class ResponseResult<T> {
private int code;
private String message;
private T data;
public static <T> ResponseResult<T> success(T data){
ResponseResult<T> responseResult=new ResponseResult<>();
responseResult.setCode(ResultCode.SUCCESS.getCode());
responseResult.setMessage(ResultCode.SUCCESS.getMessage());
responseResult.setData(data);
return responseResult;
}
public static <T> ResponseResult<T> success(){
ResponseResult<T> responseResult=new ResponseResult<>();
responseResult.setCode(ResultCode.SUCCESS.getCode());
responseResult.setMessage(ResultCode.SUCCESS.getMessage());
return responseResult;
}
public static <T> ResponseResult failed(int code,String message){
ResponseResult<T> responseResult=new ResponseResult<>();
responseResult.setCode(code);
responseResult.setMessage(message);
return responseResult;
}
public static boolean isSucceed(ResponseResult responseResult){
return responseResult.getCode()==ResultCode.SUCCESS.getCode();
}
}
四.常用工具
除了这些基本的工具之外,我再推荐几款我们项目中常用的工具
我们项目常常依赖中间件,比如mysql,kafka,redis等,如果要单元测试,我们通常的做法是在dev环境部署一套项目中依赖的中间件,非常麻烦,而且数据还不容易隔离,所以内存版的中间件就是来解决这个问题的。
内存版Redis: GitHub - kstyrc/embedded-redis: Redis embedded server for Java integration testing
内存版DB: MariaDB · GitHub
内存版kafka,springboot提供了测试依赖,直接引入starter即可
hutool:非常好用的java工具类库 Hutool🍬一个功能丰富且易用的Java工具库,涵盖了字符串、数字、集合、编码、日期、文件、IO、加密、数据库JDBC、JSON、HTTP客户端等功能。
mybatis plus:非常好用的ORM框架 MyBatis-Plus (baomidou.com)
mapStruct:java bean 映射工具 MapStruct – Java bean mappings, the easy way!
总结
在真实的工作中,IDE的配置工作其实不是最麻烦的和最浪费的时间的,有一件事情更加浪费时间,每次搞的我都特别的崩溃,这件事情也和环境相关,同时也和其他人相关。你们猜猜是什么事情呢?
链接:https://juejin.cn/post/7360947498943578139
来源:稀土掘金