upd: 更新基础代码及配置

.editorConfig

+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+
+[**.yml]
+indent_size = 2

app/build.gradle

 dependencies {
-    implementation project(":basic-auth")
-    implementation project(":basic-common:core")
-    implementation project(":basic-common:util")
-    runtimeOnly project(":basic-common:doc")
+	implementation project(":basic-auth")
+	implementation project(":basic-common:core")
+	implementation project(":basic-common:util")
+	implementation project(":basic-common:doc")
 
-    implementation 'org.springframework.boot:spring-boot-starter-web'
-    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
-    runtimeOnly 'mysql:mysql-connector-java'
+	implementation 'org.springframework.boot:spring-boot-starter-web'
+	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
+	runtimeOnly 'mysql:mysql-connector-java'
 
-    implementation 'io.swagger:swagger-annotations:1.6.3'
+	// swagger
+	implementation "io.swagger:swagger-annotations:${swaggerAnnotationsVersion}"
+	implementation "org.hibernate.validator:hibernate-validator:${hibernateValidatorVersion}"
 }

app/src/main/java/com/yiring/app/Application.java

+/* (C) 2021 YiRing, Inc. */
 package com.yiring.app;
 
 import org.springframework.boot.SpringApplication;
@@ -12,5 +13,4 @@ public class Application {
     public static void main(String[] args) {
         SpringApplication.run(Application.class, args);
     }
-
 }

app/src/main/java/com/yiring/app/config/GlobalExceptionHandler.java

+/* (C) 2021 YiRing, Inc. */
+package com.yiring.app.config;
+
+import com.yiring.common.core.Result;
+import com.yiring.common.core.Status;
+import javax.validation.ConstraintViolationException;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.validation.BindException;
+import org.springframework.validation.BindingResult;
+import org.springframework.web.HttpRequestMethodNotSupportedException;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+/**
+ * 全局错误处理
+ *
+ * @author fangzhimin
+ * 2017年11月30日 上午11:36:31
+ */
+@Slf4j
+@ControllerAdvice
+@ResponseBody
+public class GlobalExceptionHandler {
+
+    /**
+     * 参数校验异常
+     *
+     * @param e 异常信息
+     * @return 统一的校验失败信息 {@link Status#BAD_REQUEST
+     */
+    @ExceptionHandler(
+        value = { BindException.class, MethodArgumentNotValidException.class, ConstraintViolationException.class }
+    )
+    public Result<String> bindErrorHandler(Exception e) {
+        String error = "未知参数校验错误";
+
+        if (e instanceof ConstraintViolationException) {
+            ConstraintViolationException ex = (ConstraintViolationException) e;
+            error = ex.getConstraintViolations().iterator().next().getMessage();
+        } else {
+            BindingResult result = null;
+            if (e instanceof MethodArgumentNotValidException) {
+                result = ((MethodArgumentNotValidException) e).getBindingResult();
+            } else if (e instanceof BindException) {
+                result = ((BindException) e).getBindingResult();
+            }
+
+            if (result != null) {
+                error = result.getAllErrors().iterator().next().getDefaultMessage();
+            }
+        }
+
+        return Result.no(Status.BAD_REQUEST, error);
+    }
+
+    /**
+     * 不支持的HttpMethod异常
+     *
+     * @param e 异常信息
+     * @return 异常信息反馈 {@link Status#METHOD_NOT_ALLOWED
+     */
+    @ExceptionHandler(value = HttpRequestMethodNotSupportedException.class)
+    public Result<String> httpRequestMethodNotSupportedErrorHandler(Exception e) {
+        return Result.no(Status.METHOD_NOT_ALLOWED, e.getMessage());
+    }
+
+    /**
+     * 其他异常
+     *
+     * @param e 异常信息
+     * @return 统一的500异常信息 {@link Status#INTERNAL_SERVER_ERROR
+     */
+    @ExceptionHandler(value = Exception.class)
+    public Result<String> defaultErrorHandler(Exception e) {
+        log.error(e.getMessage(), e);
+        return Result.no(Status.INTERNAL_SERVER_ERROR, e);
+    }
+}

app/src/main/java/com/yiring/app/param/BasicIdParam.java

+/* (C) 2021 YiRing, Inc. */
+package com.yiring.app.param;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import java.io.Serializable;
+import javax.validation.Valid;
+import javax.validation.constraints.NotNull;
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.experimental.FieldDefaults;
+import lombok.experimental.SuperBuilder;
+
+/**
+ * 公共的ID查询参数类
+ *
+ * @author ifzm
+ * @version 0.1 2019/5/28 22:11
+ */
+@ApiModel("公共的ID查询参数类")
+@Valid
+@Data
+@SuperBuilder
+@NoArgsConstructor
+@AllArgsConstructor
+@FieldDefaults(level = AccessLevel.PRIVATE)
+public class BasicIdParam implements Serializable {
+
+    private static final long serialVersionUID = -8690942241103456893L;
+
+    @ApiModelProperty(value = "id", example = "1", required = true)
+    @NotNull(message = "id 不能为空")
+    Long id;
+}

app/src/main/java/com/yiring/app/param/BasicPaginationParam.java

+/* (C) 2021 YiRing, Inc. */
+package com.yiring.app.param;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import java.io.Serializable;
+import java.util.Objects;
+import javax.validation.constraints.DecimalMin;
+import javax.validation.constraints.NotNull;
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.experimental.FieldDefaults;
+import lombok.experimental.SuperBuilder;
+import org.springframework.data.domain.PageRequest;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.domain.Sort;
+
+/**
+ * 分页查询参数公共父类
+ *
+ * @author ifzm
+ * @version 0.1 2019/3/10 16:29
+ */
+@SuppressWarnings({ "unused" })
+@ApiModel
+@Data
+@SuperBuilder
+@NoArgsConstructor
+@AllArgsConstructor
+@FieldDefaults(level = AccessLevel.PRIVATE)
+public class BasicPaginationParam implements Serializable {
+
+    private static final long serialVersionUID = 6103761701912769946L;
+
+    @ApiModelProperty(value = "分页条数", example = "10", required = true)
+    @NotNull(message = "分页条数不能为空")
+    @DecimalMin(value = "1", message = "分页条数不能小于1")
+    Integer pageSize;
+
+    @ApiModelProperty(value = "当前页数", example = "1", required = true)
+    @NotNull(message = "当前页数不能为空")
+    @DecimalMin(value = "1", message = "当前页数不能小于1")
+    Integer pageNo;
+
+    @ApiModelProperty(value = "排序参数", example = "id")
+    String sortField;
+
+    @ApiModelProperty(value = "排序方向（ASC|DESC）", example = "DESC")
+    Sort.Direction sortOrder;
+
+    /**
+     * 根据参数构建分页对象
+     *
+     * @param paginationParam {@link BasicPaginationParam}
+     * @return Pageable
+     */
+    public static Pageable toPageable(BasicPaginationParam paginationParam) {
+        if (paginationParam == null) {
+            return Pageable.unpaged();
+        }
+
+        Sort sort = Sort.unsorted();
+        if (Objects.nonNull(paginationParam.getSortField())) {
+            sort = Sort.by(new Sort.Order(paginationParam.getSortOrder(), paginationParam.getSortField()));
+        }
+        return PageRequest.of(paginationParam.getPageNo() - 1, paginationParam.getPageSize(), sort);
+    }
+}

app/src/main/java/com/yiring/app/vo/BasicPaginationVo.java

+/* (C) 2021 YiRing, Inc. */
+package com.yiring.app.vo;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import java.io.Serializable;
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.experimental.FieldDefaults;
+import lombok.experimental.SuperBuilder;
+
+/**
+ * 分页查询响应公共父类
+ *
+ * @author ifzm
+ * @version 0.1 2019/3/10 16:29
+ */
+@ApiModel
+@Data
+@SuperBuilder
+@NoArgsConstructor
+@AllArgsConstructor
+@FieldDefaults(level = AccessLevel.PRIVATE)
+public class BasicPaginationVo implements Serializable {
+
+    private static final long serialVersionUID = 6103761701912769946L;
+
+    @ApiModelProperty(value = "数据总数", example = "100")
+    Long total;
+}

app/src/main/java/com/yiring/app/web/HelloController.java

+/* (C) 2021 YiRing, Inc. */
 package com.yiring.app.web;
 
 import com.yiring.common.core.Result;
@@ -13,5 +14,4 @@ public class HelloController {
     public Result<String> hello() {
         return Result.ok("😎 Hello World!");
     }
-
 }

app/src/main/resources/application-app.yml → app/src/main/resources/application-dev.yml

 spring:
   datasource:
-    url: jdbc:mysql://127.0.0.1:3306/basic?useSSL=false&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
+    url: jdbc:mysql://127.0.0.1:3306/basic?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
     username: root
     password: 123456
   jpa:
@@ -8,4 +8,4 @@ spring:
     show-sql: true
     open-in-view: true
     hibernate:
-      ddl-auto: update
+      ddl-auto: update
\ No newline at end of file

app/src/main/resources/application.yml

@@ -7,5 +7,8 @@ spring:
   application:
     name: "basic-api-app"
   profiles:
-    include: auth,doc,app
-debug: true
+    include: auth,doc
+    active: dev
+
+# DEBUG
+debug: false

app/src/test/java/com/yiring/ApplicationTests.java

+/* (C) 2021 YiRing, Inc. */
 package com.yiring;
 
 import org.junit.jupiter.api.Test;
@@ -7,7 +8,5 @@ import org.springframework.boot.test.context.SpringBootTest;
 class ApplicationTests {
 
     @Test
-    void contextLoads() {
-    }
-
+    void contextLoads() {}
 }

basic-auth/build.gradle

 dependencies {
-    implementation project(':basic-common:core')
+	implementation project(':basic-common:core')
 
-    implementation "cn.dev33:sa-token-spring-boot-starter:${saTokenVersion}"
-}
+	implementation "cn.dev33:sa-token-spring-boot-starter:${saTokenVersion}"
+}
\ No newline at end of file

basic-common/build.gradle

-dependencies {
-}
\ No newline at end of file

basic-common/core/build.gradle

 dependencies {
-    implementation 'org.aspectj:aspectjweaver:1.9.7'
-    implementation 'io.swagger:swagger-annotations:1.6.3'
-    implementation 'org.springframework.boot:spring-boot-starter-web'
-}
+	implementation project(":basic-common:util")
+
+	implementation 'org.springframework.boot:spring-boot-starter-aop'
+	implementation 'org.springframework.boot:spring-boot-starter-web'
\ No newline at end of file
+
+	// swagger
+	implementation "io.swagger:swagger-annotations:${swaggerAnnotationsVersion}"
+}

basic-common/core/src/main/java/com/yiring/common/aspect/RequestAspect.java

+/* (C) 2021 YiRing, Inc. */
 package com.yiring.common.aspect;
 
 import com.yiring.common.constant.DateFormatter;
 import com.yiring.common.core.Result;
+import com.yiring.common.util.Commons;
+import java.time.LocalDateTime;
+import javax.servlet.http.HttpServletRequest;
+import lombok.extern.slf4j.Slf4j;
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
 import org.aspectj.lang.annotation.Pointcut;
 import org.springframework.stereotype.Component;
-
-import java.time.LocalDateTime;
+import org.springframework.web.context.request.RequestAttributes;
+import org.springframework.web.context.request.RequestContextHolder;
 
 /**
  * 请求接口切面，记录接口耗时
@@ -17,26 +22,47 @@ import java.time.LocalDateTime;
  * @version 0.1
  */
 
+@Slf4j
 @Aspect
 @Component
 public class RequestAspect {
 
-    @Pointcut("@annotation(org.springframework.web.bind.annotation.PostMapping) || @annotation(org.springframework.web.bind.annotation.GetMapping) || @annotation(org.springframework.web.bind.annotation.ExceptionHandler)")
-    public void apiPointCut() {
-    }
+    @Pointcut(
+        "@annotation(org.springframework.web.bind.annotation.PostMapping) || @annotation(org.springframework.web.bind.annotation.GetMapping) || @annotation(org.springframework.web.bind.annotation.ExceptionHandler)"
+    )
+    public void apiPointCut() {}
 
     @Around("apiPointCut()")
     public Object around(ProceedingJoinPoint point) throws Throwable {
+        HttpServletRequest request = getRequest();
+
         long start = System.currentTimeMillis();
         Object result = point.proceed();
         long end = System.currentTimeMillis();
 
+        String timestamp = LocalDateTime.now().format(DateFormatter.DATE_TIME);
+        String times = String.format("%.3fs", (double) (end - start) / 1000);
+
+        // Print Request Log (Optional Replace: MDC)
+        log.info(
+            "[Request] {} - URL: {}, IP: {}, Times: {}",
+            timestamp,
+            request.getRequestURL(),
+            Commons.getClientIpAddress(request),
+            times
+        );
+
         if (result instanceof Result) {
-            ((Result<?>) result).setTimestamp(LocalDateTime.now().format(DateFormatter.DATE_TIME));
-            ((Result<?>) result).setTimes(String.format("%.3fs", (double) (end - start) / 1000));
+            ((Result<?>) result).setTimestamp(timestamp);
+            ((Result<?>) result).setTimes(times);
         }
 
         return result;
     }
 
+    private HttpServletRequest getRequest() {
+        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
+        assert requestAttributes != null;
+        return (HttpServletRequest) requestAttributes.resolveReference(RequestAttributes.REFERENCE_REQUEST);
+    }
 }

basic-common/core/src/main/java/com/yiring/common/constant/DateFormatter.java

+/* (C) 2021 YiRing, Inc. */
 package com.yiring.common.constant;
 
-import lombok.experimental.UtilityClass;
-
 import java.time.format.DateTimeFormatter;
+import lombok.experimental.UtilityClass;
 
 /**
  * 初始化一下常用的日期格式化规则
@@ -30,5 +30,4 @@ public class DateFormatter {
      * DateTimeFormatter.ofPattern("HH:mm:ss")
      */
     public final DateTimeFormatter TIME = DateTimeFormatter.ofPattern("HH:mm:ss");
-
 }

basic-common/core/src/main/java/com/yiring/common/core/Result.java

+/* (C) 2021 YiRing, Inc. */
 package com.yiring.common.core;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;
+import java.io.Serializable;
 import lombok.AccessLevel;
 import lombok.Builder;
 import lombok.Data;
 import lombok.experimental.FieldDefaults;
 import lombok.extern.slf4j.Slf4j;
 
-import java.io.Serializable;
-
 /**
  * 标准的响应对象（所有的接口响应内容格式都应该是一致的）
  *
@@ -27,6 +27,7 @@ import java.io.Serializable;
 @Builder
 @FieldDefaults(level = AccessLevel.PRIVATE)
 public class Result<T extends Serializable> implements Serializable {
+
     private static final long serialVersionUID = -4802543396830024571L;
 
     /**
@@ -78,10 +79,7 @@ public class Result<T extends Serializable> implements Serializable {
      * @see com.yiring.common.core.Status
      */
     public static <T extends Serializable> Result<T> ok() {
-        return (Result<T>) Result.builder()
-            .status(Status.OK.value())
-            .message(Status.OK.getReasonPhrase())
-            .build();
+        return (Result<T>) Result.builder().status(Status.OK.value()).message(Status.OK.getReasonPhrase()).build();
     }
 
     /**
@@ -91,7 +89,8 @@ public class Result<T extends Serializable> implements Serializable {
      * @return Result
      */
     public static <T extends Serializable> Result<T> ok(T body) {
-        return (Result<T>) Result.builder()
+        return (Result<T>) Result
+            .builder()
             .status(Status.OK.value())
             .message(Status.OK.getReasonPhrase())
             .body(body)
@@ -135,7 +134,8 @@ public class Result<T extends Serializable> implements Serializable {
      * @see Status
      */
     public static <T extends Serializable> Result<T> no(Status status, String details, Throwable error) {
-        Result<T> result = (Result<T>) Result.builder()
+        Result<T> result = (Result<T>) Result
+            .builder()
             .status(status.value())
             .message(status.getReasonPhrase())
             .details(details)
@@ -147,5 +147,4 @@ public class Result<T extends Serializable> implements Serializable {
 
         return result;
     }
-
 }

basic-common/core/src/main/java/com/yiring/common/core/Status.java

+/* (C) 2021 YiRing, Inc. */
 package com.yiring.common.core;
 
 import org.springframework.lang.Nullable;
@@ -9,7 +10,6 @@ import org.springframework.lang.Nullable;
 
 @SuppressWarnings({ "unused" })
 public enum Status {
-
     /**
      * 成功
      */

basic-common/doc/build.gradle

 dependencies {
-    implementation project(":basic-common:core")
+	implementation project(":basic-common:core")
 
-    implementation 'org.springframework.boot:spring-boot-starter-web'
+	implementation 'org.springframework.boot:spring-boot-starter-web'
+
+	// swagger(knife4j)
+	implementation "com.github.xiaoymin:knife4j-spring-boot-starter:${knife4jVersion}"
+	implementation "org.hibernate.validator:hibernate-validator:${hibernateValidatorVersion}"
 
-    // swagger(knife4j)
-    implementation "com.github.xiaoymin:knife4j-spring-boot-starter:${knife4jVersion}"
 }

basic-common/doc/src/main/java/com/yiring/common/package-info.java

-package com.yiring.common;
+package com.yiring.common;
\ No newline at end of file

basic-common/doc/src/main/java/com/yiring/common/swagger/SwaggerConfig.java

+/* (C) 2021 YiRing, Inc. */
 package com.yiring.common.swagger;
 
 import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
 import com.yiring.common.core.Status;
 import io.swagger.annotations.Api;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
+import javax.annotation.Resource;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 import org.springframework.context.annotation.Profile;
-import org.springframework.http.HttpMethod;
+import org.springframework.web.bind.annotation.RequestMethod;
 import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
 import springfox.documentation.builders.*;
-import springfox.documentation.schema.ScalarType;
+import springfox.documentation.schema.ModelRef;
 import springfox.documentation.service.*;
 import springfox.documentation.spi.DocumentationType;
 import springfox.documentation.spring.web.plugins.Docket;
-import springfox.documentation.swagger2.annotations.EnableSwagger2;
-
-import javax.annotation.Resource;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-import java.util.function.Predicate;
-import java.util.stream.Collectors;
+import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
 
 /**
  * Swagger Config
@@ -34,15 +34,16 @@ import java.util.stream.Collectors;
  */
 
 @Slf4j
-@Profile(value = { "dev", "test", "preview" })
-@EnableSwagger2
+@Profile(value = { "default", "dev", "mock", "test", "preview" })
+@EnableSwagger2WebMvc
 @Configuration
 @Import(BeanValidatorPluginsConfiguration.class)
 public class SwaggerConfig {
 
     @Value("${spring.application.name}")
     String applicationName;
-    @Value("${spring.server.port}")
+
+    @Value("${server.port}")
     String serverPort;
 
     @Resource
@@ -56,29 +57,29 @@ public class SwaggerConfig {
     private Docket api(Predicate<String> paths) {
         log.info("API Doc: http://localhost:{}/doc.html", serverPort);
 
+        String group = "default";
         return new Docket(DocumentationType.SWAGGER_2)
-            .groupName("default")
+            .groupName(group)
             .apiInfo(apiInfo())
             .useDefaultResponseMessages(false)
-            .globalRequestParameters(buildGlobalRequestParameters())
-            .globalResponses(HttpMethod.GET, buildGlobalResponseMessage())
-            .globalResponses(HttpMethod.POST, buildGlobalResponseMessage())
+            .globalOperationParameters(buildGlobalRequestParameters())
+            .globalResponseMessage(RequestMethod.GET, buildGlobalResponseMessage())
+            .globalResponseMessage(RequestMethod.POST, buildGlobalResponseMessage())
+            .globalResponseMessage(RequestMethod.DELETE, buildGlobalResponseMessage())
+            .globalResponseMessage(RequestMethod.PUT, buildGlobalResponseMessage())
             .select()
             .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
             .paths(paths)
             .build()
-            .extensions(openApiExtensionResolver.buildSettingExtensions());
+            .extensions(openApiExtensionResolver.buildExtensions(group));
     }
 
     private ApiInfo apiInfo() {
-        String url = "https://yiring.com";
-
         return new ApiInfoBuilder()
             .title("Swagger 接口文档.")
             .description(applicationName)
             .version("1.0")
-            .termsOfServiceUrl(url)
-            .contact(new Contact("YiRing", url, "developer@yiring.com"))
+            .contact(new Contact("© YiRing", "https://yiring.com", "developer@yiring.com"))
             .build();
     }
 
@@ -87,15 +88,18 @@ public class SwaggerConfig {
      *
      * @return Token 等自定义全局参数/Header
      */
-    private List<RequestParameter> buildGlobalRequestParameters() {
-        List<RequestParameter> parameters = new ArrayList<>();
-        parameters.add(new RequestParameterBuilder()
-            .name("Authorization")
-            .description("Auth Token")
-            .required(true)
-            .in(ParameterType.HEADER)
-            .query(q -> q.model(m -> m.scalarModel(ScalarType.STRING)))
-            .build());
+    private List<Parameter> buildGlobalRequestParameters() {
+        List<Parameter> parameters = new ArrayList<>();
+        parameters.add(
+            new ParameterBuilder()
+                .name("Authorization")
+                .description("Auth Token")
+                .required(true)
+                .parameterType("header")
+                .defaultValue("Basic Auth Token")
+                .modelRef(new ModelRef("String"))
+                .build()
+        );
         return parameters;
     }
 
@@ -104,13 +108,10 @@ public class SwaggerConfig {
      *
      * @return 所有自定义状态码消息
      */
-    private List<Response> buildGlobalResponseMessage() {
-        return Arrays.stream(Status.values())
-            .map(status -> new ResponseBuilder()
-                .code(String.valueOf(status.value()))
-                .description(status.getReasonPhrase())
-                .build())
+    private List<ResponseMessage> buildGlobalResponseMessage() {
+        return Arrays
+            .stream(Status.values())
+            .map(status -> new ResponseMessageBuilder().code(status.value()).message(status.getReasonPhrase()).build())
             .collect(Collectors.toList());
     }
-
 }

basic-common/doc/src/main/resources/application-doc.yml

@@ -5,4 +5,5 @@ knife4j:
     username: admin
     password: 123456
   setting:
-    enableOpenApi: false
+    enableOpenApi: false
\ No newline at end of file
+    enableDebug: true

basic-common/util/build.gradle

+dependencies {
+	implementation 'org.springframework.boot:spring-boot-starter-web'
+
+	implementation "org.apache.commons:commons-lang3:${commonsLangVersion}"
+}

basic-common/util/src/main/java/com/yiring/common/jackson/MappingSerialize.java

+/* (C) 2021 YiRing, Inc. */
+package com.yiring.common.jackson;
+
+import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import java.lang.annotation.*;
+
+/**
+ * Jackson Mapping 序列化
+ *
+ * @author Jim
+ * @version 0.1
+ * 2021/10/15 18:05
+ */
+
+@Target({ ElementType.FIELD, ElementType.ANNOTATION_TYPE })
+@Retention(RetentionPolicy.RUNTIME)
+@JacksonAnnotationsInside
+@JsonSerialize(using = ObjectMappingSerializer.class)
+@Documented
+public @interface MappingSerialize {
+    /**
+     * 处理简单 Mapping 数据字典转换输出，常用于枚举数据处理
+     * eg: @MappingSerialize(mapping = "0:女,1:男")
+     */
+    String mapping();
+}

basic-common/util/src/main/java/com/yiring/common/jackson/ObjectMappingSerializer.java

+/* (C) 2021 YiRing, Inc. */
+package com.yiring.common.jackson;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.BeanProperty;
+import com.fasterxml.jackson.databind.JsonSerializer;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import com.fasterxml.jackson.databind.ser.ContextualSerializer;
+import com.fasterxml.jackson.databind.ser.std.StdSerializer;
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Objects;
+import org.apache.commons.lang3.StringUtils;
+
+/**
+ * Mapping 序列化
+ *
+ * @author Jim
+ * @version 0.1
+ * 2021/10/15 18:11
+ */
+public class ObjectMappingSerializer extends StdSerializer<Object> implements ContextualSerializer {
+
+    private static final long serialVersionUID = -1924851196524453827L;
+
+    protected ObjectMappingSerializer() {
+        super(Object.class);
+    }
+
+    private final Map<String, String> mapping = new HashMap<>();
+
+    public void putAll(Map<String, String> map) {
+        this.mapping.putAll(map);
+    }
+
+    @Override
+    public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) {
+        MappingSerialize mappingSerialize = property.getAnnotation(MappingSerialize.class);
+        String mapping = mappingSerialize.mapping();
+
+        Map<String, String> map = new HashMap<>();
+        if (!StringUtils.isEmpty(mapping)) {
+            String[] strings = mapping.split(",");
+            for (String str : strings) {
+                String[] split = str.split(":");
+                map.put(split[0], split[1]);
+            }
+        }
+
+        ObjectMappingSerializer serializer = new ObjectMappingSerializer();
+        serializer.putAll(map);
+        return serializer;
+    }
+
+    @Override
+    public void serialize(Object value, JsonGenerator gen, SerializerProvider provider) throws IOException {
+        String text = mapping.get(Objects.toString(value));
+        if (StringUtils.isEmpty(text)) {
+            gen.writeObject(value);
+        } else {
+            gen.writeString(text);
+        }
+    }
+}

basic-common/util/src/main/java/com/yiring/common/package-info.java

+/**
+ * @author Jim
+ * @version 0.1
+ * 2021/11/22 13:03
+ */
+package com.yiring.common;

basic-common/util/src/main/java/com/yiring/common/util/Commons.java

+/* (C) 2021 YiRing, Inc. */
+package com.yiring.common.util;
+
+import java.util.Collection;
+import java.util.Map;
+import java.util.UUID;
+import javax.servlet.http.HttpServletRequest;
+import lombok.experimental.UtilityClass;
+
+/**
+ * 公共工具类
+ *
+ * @author ifzm
+ * @version 0.1 2019/3/5 20:29
+ */
+
+@SuppressWarnings({ "unused" })
+@UtilityClass
+public class Commons {
+
+    /** 代理 IP 请求头 */
+    private static final String[] HEADERS_TO_TRY = {
+        "X-Forwarded-For",
+        "Proxy-Client-IP",
+        "WL-Proxy-Client-IP",
+        "HTTP_X_FORWARDED_FOR",
+        "HTTP_X_FORWARDED",
+        "HTTP_X_CLUSTER_CLIENT_IP",
+        "HTTP_CLIENT_IP",
+        "HTTP_FORWARDED_FOR",
+        "HTTP_FORWARDED",
+        "HTTP_VIA",
+        "REMOTE_ADDR",
+        "X-Real-IP",
+    };
+
+    /***
+     * 获取客户端ip地址(可以穿透代理)
+     *
+     * @param request HttpServletRequest
+     * @return IP
+     */
+    public String getClientIpAddress(HttpServletRequest request) {
+        for (String header : HEADERS_TO_TRY) {
+            String ip = request.getHeader(header);
+            if (ip != null && ip.length() != 0 && !"unknown".equalsIgnoreCase(ip)) {
+                return ip;
+            }
+        }
+
+        return request.getRemoteAddr();
+    }
+
+    /**
+     * 随机生成一个UUID
+     *
+     * @return UUID 字符串
+     */
+    public String uuid() {
+        return UUID.randomUUID().toString().replace("-", "");
+    }
+
+    /**
+     * 判断集合是否为空
+     *
+     * @param collection 集合
+     * @return 是否为空
+     */
+    public boolean isNullOrEmpty(Collection<?> collection) {
+        return collection == null || collection.isEmpty();
+    }
+
+    /**
+     * 判断Map是否为空
+     *
+     * @param map Map
+     * @return 是否为空
+     */
+    public boolean isNullOrEmpty(Map<?, ?> map) {
+        return map == null || map.isEmpty();
+    }
+}

build.gradle

 buildscript {
+    repositories {
+        maven { url "https://plugins.gradle.org/m2/" }
+    }
     ext {
-        knife4jVersion = '3.0.3'
-        saTokenVersion = '1.27.0'
+        // https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter
+        knife4jVersion = '2.0.9'
+        // https://mvnrepository.com/artifact/io.swagger/swagger-annotations
+        swaggerAnnotationsVersion = '1.6.3'
+        // https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator
+        hibernateValidatorVersion = '6.0.22.Final'
+        // https://mvnrepository.com/artifact/cn.dev33/sa-token-spring-boot-starter
+        saTokenVersion = '1.28.0'
+        // https://mvnrepository.com/artifact/org.apache.commons/commons-lang3
+        commonsLangVersion = '3.12.0'
     }
 }
 
 plugins {
-    id 'org.springframework.boot' version '2.5.6'
+    id 'org.springframework.boot' version '2.5.7'
     id 'io.spring.dependency-management' version '1.0.11.RELEASE'
     id 'java'
+    // https://plugins.gradle.org/plugin/com.diffplug.spotless
+    id "com.diffplug.spotless" version "6.0.0"
+    // https://plugins.gradle.org/plugin/com.github.spotbugs
+    id "com.github.spotbugs" version "4.7.10"
 }
 
 group = 'com.yiring'
@@ -27,6 +42,8 @@ subprojects {
     apply plugin: 'org.springframework.boot'
     apply plugin: 'io.spring.dependency-management'
     apply plugin: 'java'
+    apply plugin: "com.diffplug.spotless"
+    apply plugin: "com.github.spotbugs"
 
     configurations {
         compileOnly {
@@ -55,4 +72,46 @@ subprojects {
     test {
         useJUnitPlatform()
     }
-}
+
\ No newline at end of file
+    // skip Test tasks
+    gradle.taskGraph.whenReady {
+        tasks.each { task ->
+            if (task.name.contains("test")) {
+                task.enabled = false
+            }
+        }
+    }
+
+    spotless {
+        format 'misc', {
+            target '*.gradle', '*.md', '.gitignore'
+            trimTrailingWhitespace()
+            indentWithTabs()
+            endWithNewline()
+        }
+        java {
+            importOrder()
+            removeUnusedImports()
+            licenseHeader '/* (C) $YEAR YiRing, Inc. */'
+            // https://www.npmjs.com/package/prettier
+            // https://www.npmjs.com/package/prettier-plugin-java
+            prettier(['prettier': '2.4.1', 'prettier-plugin-java': '1.6.0']).config([
+                'parser'    : 'java',
+                'tabWidth'  : 4,
+                'printWidth': 120,
+                'endOfLine' : 'lf'
+            ])
+        }
+    }
+}
+
+// GitHook pre-commit (spotless, spotbugs)
+def hook = new File("$rootProject.projectDir/.git/hooks/pre-commit")
+hook.text = """#!/bin/bash
+#set -x
+
+./gradlew spotlessCheck spotbugsMain
+
+RESULT=\$?
+exit \$RESULT
+"""

settings.gradle

 pluginManagement {
     repositories {
         maven { url "https://maven.aliyun.com/repository/gradle-plugin" }
+        gradlePluginPortal()
     }
 }
 rootProject.name = 'basic'