4 Achegas 51ed7a649a ... 5098573e66

Autor SHA1 Mensaxe Data
  liuchuanwei 5098573e66 Merge remote-tracking branch 'origin/master' hai 1 mes
  liuchuanwei ac6a78ad35 feat:修改接口参数校验机制 hai 1 mes
  liuchuanwei a267b99bab feat:添加接口全局统一异常处理 hai 1 mes
  liuchuanwei 87d03f9631 log:添加logback日志框架 hai 1 mes

+ 24 - 5
pom.xml

@@ -12,6 +12,8 @@
         <maven.compiler.target>8</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <springframework.version>5.2.15.RELEASE</springframework.version>
+        <slf4j.version>1.7.25</slf4j.version>
+        <logback.version>1.1.11</logback.version>
     </properties>
     <dependencies>
         <!--Spring核心依赖-->
@@ -43,9 +45,14 @@
         </dependency>
         <!-- 请求参数校验 -->
         <dependency>
+            <groupId>javax.validation</groupId>
+            <artifactId>validation-api</artifactId>
+            <version>2.0.1.Final</version>
+        </dependency>
+        <dependency>
             <groupId>org.hibernate</groupId>
             <artifactId>hibernate-validator</artifactId>
-            <version>6.0.1.Final</version>
+            <version>6.2.5.Final</version>
         </dependency>
 
         <dependency>
@@ -97,15 +104,27 @@
         </dependency>
 
         <!--加载日志-->
+        <!-- slf4j -->
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>
-            <version>1.7.25</version>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <!-- logback -->
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-core</artifactId>
+            <version>${logback.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>${logback.version}</version>
         </dependency>
         <dependency>
-            <groupId>log4j</groupId>
-            <artifactId>log4j</artifactId>
-            <version>1.2.17</version>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-access</artifactId>
+            <version>${logback.version}</version>
         </dependency>
         <!-- StringUtils -->
         <dependency>

+ 1 - 1
src/main/java/com/anyway/favor/BusinessException.java → src/main/java/com/anyway/exception/BusinessException.java

@@ -1,4 +1,4 @@
-package com.anyway.favor;
+package com.anyway.exception;
 
 /**
  * 业务异常

+ 36 - 0
src/main/java/com/anyway/exception/GlobalExceptionHandler.java

@@ -0,0 +1,36 @@
+package com.anyway.exception;
+
+import com.anyway.util.R;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.validation.ObjectError;
+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;
+
+import java.util.stream.Collectors;
+
+/**
+ * @Description: 全局异常处理器
+ *
+ * @author liuchuanwei
+ * @date 2024-08-13
+ */
+@Slf4j
+@ControllerAdvice
+public class GlobalExceptionHandler {
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    @ResponseBody
+    public R<Void> handleValidException(MethodArgumentNotValidException e){
+        log.error("参数校验失败:{}", e.getMessage(), e);
+        String errorMessages = e.getBindingResult().getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.joining(";"));
+        return R.fail(errorMessages);
+    }
+
+    @ExceptionHandler(RuntimeException.class)
+    @ResponseBody
+    public R<Void> handleRuntimeException(RuntimeException e){
+        log.error("系统异常:{}", e.getMessage(), e);
+        return R.fail("系统异常:" + e.getMessage());
+    }
+}

+ 4 - 2
src/main/java/com/anyway/favor/controller/FavorController.java

@@ -3,6 +3,7 @@ package com.anyway.favor.controller;
 import com.anyway.favor.model.Favor;
 import com.anyway.favor.model.User;
 import com.anyway.favor.model.dto.FavorDto;
+import com.anyway.favor.model.enums.Update;
 import com.anyway.favor.service.FavorService;
 import com.anyway.util.PageQuery;
 import com.anyway.util.R;
@@ -11,6 +12,7 @@ import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.*;
 
+import javax.validation.groups.Default;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -34,7 +36,7 @@ public class FavorController {
      * @return
      */
     @PostMapping("/add")
-    public R<Boolean> add(@RequestBody @Validated FavorDto favorAddDto) {
+    public R<Void> add(@Validated @RequestBody FavorDto favorAddDto) {
         User currentUser = SessionUtils.currentUser();
         favorAddDto.setCreateBy(currentUser.getId());
         return favorService.add(favorAddDto) ? R.ok() : R.fail("新增失败");
@@ -47,7 +49,7 @@ public class FavorController {
      * @return
      */
     @PostMapping("/update")
-    public R<Boolean> update(@RequestBody @Validated FavorDto favorAddDto) {
+    public R<Void> update(@Validated({Update.class, Default.class }) @RequestBody FavorDto favorAddDto) {
         if (favorAddDto.getId() == null) {
             return R.fail("人情事件ID不能为空");
         }

+ 9 - 7
src/main/java/com/anyway/favor/model/Favor.java

@@ -1,5 +1,6 @@
 package com.anyway.favor.model;
 
+import com.anyway.favor.model.enums.Update;
 import com.fasterxml.jackson.annotation.JsonFormat;
 import lombok.Getter;
 import lombok.Setter;
@@ -13,7 +14,7 @@ import java.util.Date;
 
 /**
  * 人情实体类
- * 
+ *
  * @author anyway
  * @date 2024-02-20
  */
@@ -23,24 +24,25 @@ public class Favor extends BaseModel implements java.io.Serializable {
     /** 版本号 */
     private static final long serialVersionUID = 666680999611094083L;
     /** id */
+    @NotNull(message = "事件id不能为空", groups = {Update.class})
     private Long id;
     /** 举办日期 */
-    @NotNull
+    @NotNull(message = "举办日期不能为空")
     @DateTimeFormat(pattern = "yyyy-MM-dd")
     @JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8")
     private Date holdDate;
     /** 标题 */
-    @NotBlank
+    @NotBlank(message = "事件标题不能为空")
     private String title;
     /** 举办人 */
-    @NotNull
+    @NotNull(message = "举办人不能为空")
     private Long holdPersonId;
     /** 收入金额 */
-    @Min(0)
+    @Min(value = 0, message = "收入金额不能小于0")
     private BigDecimal incomeAmount;
     /** 支出金额 */
-    @Min(0)
+    @Min(value = 0, message = "支出金额不能小于0")
     private BigDecimal payAmount;
     /** 备注 */
     private String remark;
-}
+}

+ 2 - 3
src/main/java/com/anyway/favor/model/FavorItem.java

@@ -21,15 +21,14 @@ public class FavorItem extends BaseModel implements java.io.Serializable {
     /** 事件ID */
     private Long favorId;
     /** 收礼人ID */
-    @NotNull
+    @NotNull(message = "收礼人不能为空")
     private Long receivePersonId;
     /** 回赠礼物ID */
     private Long returnGiftId;
     /** 送礼人ID */
-    @NotNull
+    @NotNull(message = "送礼人不能为空")
     private Long givePersonId;
     /** 赠送礼物ID */
-    @NotNull
     private Long giveGiftId;
     /** 备注 */
     private String remark;

+ 4 - 2
src/main/java/com/anyway/favor/model/Gift.java

@@ -3,11 +3,12 @@ package com.anyway.favor.model;
 import lombok.Getter;
 import lombok.Setter;
 
+import javax.validation.constraints.NotBlank;
 import java.math.BigDecimal;
 
 /**
  * 礼物实体类
- * 
+ *
  * @author anyway
  * @date 2024-06-29
  */
@@ -20,10 +21,11 @@ public class Gift extends BaseModel implements java.io.Serializable {
      */
     private Long id;
     /** 礼物名称 */
+    @NotBlank(message = "礼物名称不能为空")
     private String title;
     /** 类型,M钱,T物,O其他 */
     private String type;
     /** 价值 */
     private BigDecimal amount;
 
-}
+}

+ 7 - 3
src/main/java/com/anyway/favor/model/dto/FavorDto.java

@@ -2,10 +2,12 @@ package com.anyway.favor.model.dto;
 
 import com.anyway.favor.model.Favor;
 import com.anyway.favor.model.FavorItem;
-import lombok.Data;
+import lombok.Getter;
 import lombok.NoArgsConstructor;
+import lombok.Setter;
 import org.springframework.beans.BeanUtils;
 
+import javax.validation.Valid;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -16,7 +18,8 @@ import java.util.List;
  * @date 2024-06-29
  */
 @NoArgsConstructor
-@Data
+@Setter
+@Getter
 public class FavorDto extends Favor {
 
     public FavorDto(Favor favor) {
@@ -24,7 +27,8 @@ public class FavorDto extends Favor {
     }
 
     /** 人情明细 */
-    List<FavorItemDto> favorItemList;
+    @Valid
+    private List<FavorItemDto> favorItemList;
     /**
      * 初始化人情明细
      * @param favorItemList

+ 7 - 3
src/main/java/com/anyway/favor/model/dto/FavorItemDto.java

@@ -2,11 +2,13 @@ package com.anyway.favor.model.dto;
 
 import com.anyway.favor.model.FavorItem;
 import com.anyway.favor.model.Gift;
-import com.anyway.favor.model.Person;
-import lombok.Data;
+import lombok.Getter;
 import lombok.NoArgsConstructor;
+import lombok.Setter;
 import org.springframework.beans.BeanUtils;
 
+import javax.validation.constraints.NotNull;
+
 /**
  * 人情新增对象
  *
@@ -14,11 +16,13 @@ import org.springframework.beans.BeanUtils;
  * @date 2024-06-29
  */
 @NoArgsConstructor
-@Data
+@Getter
+@Setter
 public class FavorItemDto extends FavorItem{
     /** 回赠礼物 */
     private Gift returnGift;
     /** 赠送礼物 */
+    @NotNull(message = "赠送礼物不能为空")
     private Gift giveGift;
 
     public FavorItemDto(FavorItem favorItem) {

+ 4 - 0
src/main/java/com/anyway/favor/model/enums/Add.java

@@ -0,0 +1,4 @@
+package com.anyway.favor.model.enums;
+
+public interface Add {
+}

+ 4 - 0
src/main/java/com/anyway/favor/model/enums/Update.java

@@ -0,0 +1,4 @@
+package com.anyway.favor.model.enums;
+
+public interface Update {
+}

+ 1 - 1
src/main/java/com/anyway/favor/service/impl/FavorServiceImpl.java

@@ -1,6 +1,6 @@
 package com.anyway.favor.service.impl;
 
-import com.anyway.favor.BusinessException;
+import com.anyway.exception.BusinessException;
 import com.anyway.favor.dao.FavorDao;
 import com.anyway.favor.dao.FavorItemDao;
 import com.anyway.favor.dao.GiftDao;

+ 147 - 0
src/main/resources/logback.xml

@@ -0,0 +1,147 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+
+	<!-- 定义日志文件的存储地址 -->
+	<!--
+		关于catalina.base解释如下:
+			catalina.home指向公用信息的位置,就是bin和lib的父目录。
+			catalina.base指向每个Tomcat目录私有信息的位置,就是conf、logs、temp、webapps和work的父目录。
+	-->
+	<property name="LOG_DIR" value="/data/logs/logGuide"/>
+	<!-- 定义日志最大的历史 30天 -->
+	<property name="maxHistory" value="30"/>
+	<!-- 定义日志文件大小 -->
+	<property name="maxFileSize" value="20MB"/>
+
+	<!--
+		%p:输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL
+		%r:输出自应用启动到输出该日志讯息所耗费的毫秒数
+		%t:输出产生该日志事件的线程名
+		%f:输出日志讯息所属的类别的类别名
+		%c:输出日志讯息所属的类的全名
+		%d:输出日志时间点的日期或时间,指定格式的方式: %d{yyyy-MM-dd HH:mm:ss}
+		%l:输出日志事件的发生位置,即输出日志讯息的语句在他所在类别的第几行。
+		%m:输出代码中指定的讯息,如log(message)中的message
+		%n:输出一个换行符号
+	-->
+	<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %msg:日志消息,%n是换行符-->
+	<property name="pattern" value="%d{yyyy-MM-dd:HH:mm:ss.SSS} [%thread] %-5level  %msg%n"/>
+
+
+	<!--
+		Appender: 设置日志信息的去向,常用的有以下几个
+			ch.qos.logback.core.ConsoleAppender (控制台)
+			ch.qos.logback.core.rolling.RollingFileAppender (文件大小到达指定尺寸的时候产生一个新文件)
+			ch.qos.logback.core.FileAppender (文件)
+	-->
+	<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+		<!-- 字符串System.out(默认)或者System.err -->
+		<target>System.out</target>
+		<!-- 对记录事件进行格式化 -->
+		<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
+			<pattern>${pattern}</pattern>
+		</encoder>
+	</appender>
+
+	<appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
+		<!-- 被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建 -->
+		<file>${LOG_DIR}/info.log</file>
+		<!-- 当发生滚动时,决定RollingFileAppender的行为,涉及文件移动和重命名。属性class定义具体的滚动策略类 -->
+		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+			<!-- 必要节点,包含文件名及"%d"转换符,"%d"可以包含一个java.text.SimpleDateFormat指定的时间格式,默认格式是 yyyy-MM-dd -->
+			<fileNamePattern>${LOG_DIR}/info_%d{yyyy-MM-dd}.log.%i.gz</fileNamePattern>
+			<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
+				<maxFileSize>${maxFileSize}</maxFileSize>
+			</timeBasedFileNamingAndTriggeringPolicy>
+			<!-- 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,如果是6,则只保存最近6个月的文件,删除之前的旧文件 -->
+			<maxHistory>${maxHistory}</maxHistory>
+		</rollingPolicy>
+		<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
+			<pattern>${pattern}</pattern>
+		</encoder>
+		<!-- LevelFilter: 级别过滤器,根据日志级别进行过滤 -->
+		<filter class="ch.qos.logback.classic.filter.LevelFilter">
+			<level>INFO</level>
+			<!-- 用于配置符合过滤条件的操作 ACCEPT:日志会被立即处理,不再经过剩余过滤器 -->
+			<onMatch>ACCEPT</onMatch>
+			<!-- 用于配置不符合过滤条件的操作 DENY:日志将立即被抛弃不再经过其他过滤器 -->
+			<onMismatch>DENY</onMismatch>
+		</filter>
+	</appender>
+
+	<appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
+		<file>${LOG_DIR}/error.log</file>
+		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+			<fileNamePattern>${LOG_DIR}/error_%d{yyyy-MM-dd}.log.%i.gz</fileNamePattern>
+			<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
+				<maxFileSize>${maxFileSize}</maxFileSize>
+			</timeBasedFileNamingAndTriggeringPolicy>
+			<maxHistory>${maxHistory}</maxHistory>
+		</rollingPolicy>
+		<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
+			<pattern>${pattern}</pattern>
+		</encoder>
+		<filter class="ch.qos.logback.classic.filter.LevelFilter">
+			<level>ERROR</level>
+			<onMatch>ACCEPT</onMatch>
+			<onMismatch>DENY</onMismatch>
+		</filter>
+	</appender>
+
+	<appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
+		<file>${LOG_DIR}/debug.log</file>
+		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+			<FileNamePattern>${LOG_DIR}/debug.%d{yyyy-MM-dd}.log
+			</FileNamePattern>
+		</rollingPolicy>
+		<encoder>
+			<Pattern>${pattern}</Pattern>
+		</encoder>
+		<filter class="ch.qos.logback.classic.filter.LevelFilter">
+			<level>DEBUG</level>
+			<onMatch>ACCEPT</onMatch>
+			<onMismatch>DENY</onMismatch>
+		</filter>
+	</appender>
+
+	<!--
+		用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。
+		<logger>仅有一个name属性,一个可选的level和一个可选的addtivity属性
+		name:
+			用来指定受此logger约束的某一个包或者具体的某一个类。
+		level:
+			用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
+			如果未设置此属性,那么当前logger将会继承上级的级别。
+		additivity:
+			是否向上级loger传递打印信息。默认是true。
+		<logger>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个logger
+	-->
+
+	<!--
+	<logger name="liu.log.guide.util" additivity="false">
+		<level value="info"/>
+		<appender-ref ref="STDOUT"/>
+		<appender-ref ref="DEBUG"/>
+		<appender-ref ref="INFO"/>
+		<appender-ref ref="ERROR"/>
+	</logger>
+
+	<logger name="liu.log.guide.util.file" additivity="false">
+		<level value="info"/>
+		<appender-ref ref="STDOUT"/>
+	</logger>
+	-->
+	<!--
+		也是<logger>元素,但是它是根logger。默认debug
+		level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
+		<root>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个logger。
+	-->
+	<root level="INFO">
+		<appender-ref ref="STDOUT"/>
+		<appender-ref ref="DEBUG"/>
+		<appender-ref ref="INFO"/>
+		<appender-ref ref="ERROR"/>
+	</root>
+
+
+</configuration>