github主页示例：https://github.com/tianyunperfect/springboot-parent.git

初始化web

pom

  1.     <parent>
  2.         <groupId>org.springframework.boot</groupId>
  3.         <artifactId>spring-boot-starter-parent</artifactId>
  4.         <version>2.1.5.RELEASE</version>
  5.         <relativePath/>
  6.     </parent>
  8.     <properties>
  9.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  10.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  11.         <java.version>1.8</java.version>
  12.     </properties>
  14.     <build>
  15.         <plugins>
  16.             <plugin>
  17.                 <groupId>org.springframework.boot</groupId>
  18.                 <artifactId>spring-boot-maven-plugin</artifactId>
  19.                 <configuration>
  20.                     <fork>true</fork>
  21.                     <layout>ZIP</layout>
  22.                 </configuration>
  23.             </plugin>
  24.         </plugins>
  25.     </build>
  27.     <dependencies>
  28.         <dependency>
  29.             <groupId>org.springframework.boot</groupId>
  30.             <artifactId>spring-boot-starter-web</artifactId>
  31.         </dependency>
  32.         <dependency>
  33.             <groupId>org.springframework.boot</groupId>
  34.             <artifactId>spring-boot-starter-test</artifactId>
  35.             <scope>test</scope>
  36.         </dependency>
  37.         <dependency>
  38.             <groupId>org.springframework.boot</groupId>
  39.             <artifactId>spring-boot-devtools</artifactId>
  40.             <scope>runtime</scope>
  41.             <optional>true</optional>
  42.         </dependency>
  44.         <!-- lombok -->
  45.         <dependency>
  46.             <groupId>org.projectlombok</groupId>
  47.             <artifactId>lombok</artifactId>
  48.             <version>1.18.4</version>
  49.         </dependency>
  50.         <!-- https://mvnrepository.com/artifact/com.alibaba/fastjson -->
  51.         <dependency>
  52.             <groupId>com.alibaba</groupId>
  53.             <artifactId>fastjson</artifactId>
  54.             <version>1.2.56</version>
  55.         </dependency>
  56.         <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
  57.         <dependency>
  58.             <groupId>com.google.code.gson</groupId>
  59.             <artifactId>gson</artifactId>
  60.             <version>2.8.5</version>
  61.         </dependency>
  62.     </dependencies>
  64.     <!--锁定springCloud版本-->
  65.     <dependencyManagement>
  66.         <dependencies>
  67.             <dependency>
  68.                 <groupId>org.springframework.cloud</groupId>
  69.                 <artifactId>spring-cloud-dependencies</artifactId>
  70.                 <version>Greenwich.SR2</version>
  71.                 <type>pom</type>
  72.                 <scope>import</scope>
  73.             </dependency>
  74.         </dependencies>
  75.     </dependencyManagement>

application.yml


新建配置文件 application.yml，可以有多个配置文件，线上可以在jar包同级目录新建config/application.yml，启动时会优先读取。

**

  1. #可以配置启动文件
  2. spring:
  3.   profiles:
  4.     active: dev
  5. #可以修改端口号和启动路径
  6. server:
  7.   port: 8080
  8.   servlet:
  9.     context-path: /girl

其他配置文件：
application-dev.yml：开发环境
application-test.yml：测试环境
application-prod.yml：生产环境

启动脚本：

  1. java -jar target/girl-0.0.1-SNAPSHOT.jar --spring.profiles.active=prod

启动文件

application.java

  1. @SpringBootApplication
  2. public class LogApplication {
  3.     public static void main(String[] args) {
  4.         SpringApplication.run(LogApplication.class, args);
  5.     }
  6. }

打印日志


1、开启AOP

  1. <!--开启aop-->
  2. <dependency>
  3.     <groupId>org.springframework.boot</groupId>
  4.     <artifactId>spring-boot-starter-aop</artifactId>
  5. </dependency>

2、添加日志切片：aspect/LogAspect.java

  1. import com.google.gson.Gson;
  2. import lombok.extern.slf4j.Slf4j;
  3. import org.aspectj.lang.ProceedingJoinPoint;
  4. import org.aspectj.lang.annotation.Around;
  5. import org.aspectj.lang.annotation.Aspect;
  6. import org.aspectj.lang.annotation.Pointcut;
  7. import org.springframework.stereotype.Component;
  8. import org.springframework.web.context.request.RequestContextHolder;
  9. import org.springframework.web.context.request.ServletRequestAttributes;
  11. import javax.servlet.http.HttpServletRequest;
  13. /**
  14.  * 日志切片
  15.  *
  16.  * @author tianyunperfect
  17.  * Created on 2019/9/19
  18.  */
  19. @Component
  20. @Aspect
  21. @Slf4j
  22. public class LogAspect {
  24.     @Pointcut("execution(public * com.alvin.controller..*.*(..))")
  25.     public void webLog() {
  26.     }
  28.     @Around("webLog()")
  29.     public Object doBefore(ProceedingJoinPoint joinPoint) throws Throwable {
  30.         /**
  31.          * 执行方法之前
  32.          */
  33.         long start = System.currentTimeMillis();
  34.         HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
  35.         /**
  36.          * 执行方法
  37.          */
  38.         Object result = joinPoint.proceed();
  39.         /**
  40.          * 执行方法之后
  41.          */
  42.         StringBuilder sb = new StringBuilder();
  43.         String split = "; ";
  44.         sb.append("url=" + request.getRequestURL() + split);
  45.         sb.append("method=" + request.getMethod() + split);
  46.         sb.append("class_method=" + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName() + split);
  47.         sb.append("args=" + new Gson().toJson(joinPoint.getArgs()) + split);
  48.         sb.append("consumer time(ms) = " + (System.currentTimeMillis() - start));
  49.         log.info(sb.toString());
  51.         return result;
  52.     }
  53. }

3、设置日志打印格式和位置，如果不设置会使用默认。

语雀内容

设置基础entity

1、状态值

ResultCode.java

  1. public enum ResultCode {
  2.     // 基本
  3.     SUCCESS(1, "success"),
  4.     FAIL(-1, "fail"),
  5.     UNKNOW(-2, "unknow"),
  6.     ;
  7.     private Integer code;
  8.     private String message;
  10.     ResultCode(Integer code, String message) {
  11.         this.code = code;
  12.         this.message = message;
  13.     }
  14. }

2、controller返回的result

Result.java

  1. package com.alvin.model;
  3. import lombok.AllArgsConstructor;
  4. import lombok.Data;
  5. import lombok.NoArgsConstructor;
  7. import java.io.Serializable;
  8. import java.util.ArrayList;
  10. /**
  11.  * @Description
  12.  * @Author 田云
  13.  * @Date 2020/5/1 20:54
  14.  * @Version 1.0
  15.  */
  16. @Data
  17. @NoArgsConstructor
  18. @AllArgsConstructor
  19. public class Result<T> implements Serializable {
  20.     private boolean success;
  21.     private Integer code;
  22.     private String message;
  23.     private T data;
  25.     public static <T> Result result(Boolean flag, ResultCode resultCode, T data) {
  26.         return new Result(flag, resultCode.ordinal(), resultCode.name(), data);
  27.     }
  29.     public static <T> Result success(ResultCode resultCode, T data) {
  30.         return result(true, resultCode, data);
  31.     }
  33.     public static <T> Result success(T data) {
  34.         return success(ResultCode.SUCCESS, data);
  35.     }
  37.     public static Result success() {
  38.         return success(null);
  39.     }
  41.     public static <T> Result failure(Integer code, String message) {
  42.         return new Result(false, code, message, null);
  43.     }
  45.     public static <T> Result failure(ResultCode resultCode) {
  46.         return new Result(false, resultCode.ordinal(), resultCode.name(), null);
  47.     }
  49.     public static <T> Result failure() {
  50.         return failure(ResultCode.FAIL);
  51.     }
  53.     public static void main(String[] args) {
  54.         ArrayList<String> strings = new ArrayList<>();
  55.         strings.add("12");
  56.         System.out.println(Result.success(strings));
  57.     }
  58. }

3、分页实体类

PageResult.java

  1. import lombok.AllArgsConstructor;
  2. import lombok.Data;
  4. import java.util.List;
  6. /**
  7.  * @Description
  8.  * @Author 田云
  9.  * @Date 2020/5/1 21:12
  10.  * @Version 1.0
  11.  */
  12. @Data
  13. @AllArgsConstructor
  14. public class PageResult<T> {
  15.     /**
  16.      * 第几页
  17.      *
  18.      * @mock 1
  19.      */
  20.     private Integer currentPage;
  21.     /**
  22.      * 每页数量
  23.      *
  24.      * @mock 10
  25.      */
  26.     private Integer pageSize;
  27.     /**
  28.      * 总数
  29.      *
  30.      * @mock @integer(9,99)
  31.      */
  32.     private Long total;
  33.     private List<T> list;
  34. }

捕获controller异常

通过全局异常来处理，这里我们直接捕获所有controller异常，也可以单独放在某一个controller里面。

handle/ExceptionHandle.java 

  1. import com.unisound.common.entity.Result;
  2. import lombok.extern.slf4j.Slf4j;
  3. import org.springframework.web.bind.annotation.ControllerAdvice;
  4. import org.springframework.web.bind.annotation.ExceptionHandler;
  5. import org.springframework.web.bind.annotation.ResponseBody;
  7. /**
  8.  * Class ExceptionHandle ...
  9.  *s
  10.  * @author tianyunperfect
  11.  * Created on 2019/9/19
  12.  */
  13. @ControllerAdvice
  14. @Slf4j
  15. public class ExceptionHandle {
  17.     /**
  18.      * 统一异常处理
  19.      * @param e
  20.      * @return
  21.      */
  22.     @ResponseBody
  23.     @ExceptionHandler
  24.     public Result exceptionHandle(Exception e) {
  25.             e.printStackTrace();
  26.         log.error("系统异常：{}", e.getMessage());
  27.         return Result.error(ResultCode.UNKNOW.ordinal(), e.getMessage());
  28.     }
  29. }

前端接收Long精度问题

我们把long类型数据传到前端时，会丢失精度，这里加一个配置类即可（将long转换为string）

  1. import com.fasterxml.jackson.databind.ObjectMapper;
  2. import com.fasterxml.jackson.databind.module.SimpleModule;
  3. import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.http.converter.HttpMessageConverter;
  6. import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
  7. import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer;
  8. import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
  10. import java.util.List;
  12. @Configuration
  13. public class LongToStringJsonConfig extends WebMvcConfigurationSupport {
  15.     /**
  16.      * 这个必须有，否则不能访问静态文件
  17.      * @param configurer
  18.      */
  19.     @Override
  20.     public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
  21.         configurer.enable();
  22.     }
  24.     /**
  25.      * 配置Long转string
  26.      * @param converters
  27.      */
  28.     @Override
  29.     public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
  30.         MappingJackson2HttpMessageConverter jackson2HttpMessageConverter = new MappingJackson2HttpMessageConverter();
  31.         ObjectMapper objectMapper = new ObjectMapper();
  32.         SimpleModule simpleModule = new SimpleModule();
  33.         simpleModule.addSerializer(Long.class, ToStringSerializer.instance);
  34.         simpleModule.addSerializer(Long.TYPE, ToStringSerializer.instance);
  35.         objectMapper.registerModule(simpleModule);
  36.         jackson2HttpMessageConverter.setObjectMapper(objectMapper);
  37.         converters.add(jackson2HttpMessageConverter);
  38.     }
  39. }