Compare commits
7
Commits
01d29e6ec3
..
master
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9f97cab38f | ||
|
|
9e75d3b392 | ||
|
|
42228c63a5 | ||
|
|
411565f812 | ||
|
|
c0448ff6ab | ||
|
|
7b346802e0 | ||
|
|
f152b1e655 |
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
<groupId>vip.jcfd</groupId>
|
<groupId>vip.jcfd</groupId>
|
||||||
<artifactId>zkh-framework</artifactId>
|
<artifactId>zkh-framework</artifactId>
|
||||||
<version>1.5.8</version>
|
<version>1.5.12</version>
|
||||||
<packaging>pom</packaging>
|
<packaging>pom</packaging>
|
||||||
<name>ZKH Framework</name>
|
<name>ZKH Framework</name>
|
||||||
<description>A Java framework for ZKH applications</description>
|
<description>A Java framework for ZKH applications</description>
|
||||||
|
|||||||
+1
-1
@@ -6,7 +6,7 @@
|
|||||||
<parent>
|
<parent>
|
||||||
<groupId>vip.jcfd</groupId>
|
<groupId>vip.jcfd</groupId>
|
||||||
<artifactId>zkh-framework</artifactId>
|
<artifactId>zkh-framework</artifactId>
|
||||||
<version>1.5.8</version>
|
<version>1.5.12</version>
|
||||||
</parent>
|
</parent>
|
||||||
|
|
||||||
<artifactId>zkh-common</artifactId>
|
<artifactId>zkh-common</artifactId>
|
||||||
|
|||||||
+1
-1
@@ -6,7 +6,7 @@
|
|||||||
<parent>
|
<parent>
|
||||||
<groupId>vip.jcfd</groupId>
|
<groupId>vip.jcfd</groupId>
|
||||||
<artifactId>zkh-framework</artifactId>
|
<artifactId>zkh-framework</artifactId>
|
||||||
<version>1.5.8</version>
|
<version>1.5.12</version>
|
||||||
</parent>
|
</parent>
|
||||||
|
|
||||||
<artifactId>zkh-data</artifactId>
|
<artifactId>zkh-data</artifactId>
|
||||||
|
|||||||
+1
-1
@@ -6,7 +6,7 @@
|
|||||||
<parent>
|
<parent>
|
||||||
<groupId>vip.jcfd</groupId>
|
<groupId>vip.jcfd</groupId>
|
||||||
<artifactId>zkh-framework</artifactId>
|
<artifactId>zkh-framework</artifactId>
|
||||||
<version>1.5.8</version>
|
<version>1.5.12</version>
|
||||||
</parent>
|
</parent>
|
||||||
|
|
||||||
<artifactId>zkh-file</artifactId>
|
<artifactId>zkh-file</artifactId>
|
||||||
|
|||||||
+5
-1
@@ -6,7 +6,7 @@
|
|||||||
<parent>
|
<parent>
|
||||||
<groupId>vip.jcfd</groupId>
|
<groupId>vip.jcfd</groupId>
|
||||||
<artifactId>zkh-framework</artifactId>
|
<artifactId>zkh-framework</artifactId>
|
||||||
<version>1.5.8</version>
|
<version>1.5.12</version>
|
||||||
</parent>
|
</parent>
|
||||||
|
|
||||||
<artifactId>zkh-log</artifactId>
|
<artifactId>zkh-log</artifactId>
|
||||||
@@ -14,6 +14,10 @@
|
|||||||
<description>Logging utilities for ZKH framework</description>
|
<description>Logging utilities for ZKH framework</description>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
|
<dependency>
|
||||||
|
<groupId>jakarta.servlet</groupId>
|
||||||
|
<artifactId>jakarta.servlet-api</artifactId>
|
||||||
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.boot</groupId>
|
<groupId>org.springframework.boot</groupId>
|
||||||
<artifactId>spring-boot-starter-aop</artifactId>
|
<artifactId>spring-boot-starter-aop</artifactId>
|
||||||
|
|||||||
@@ -9,6 +9,18 @@ public class ConsoleLogService implements ILogService {
|
|||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void log(String message, Authentication authentication) {
|
public void log(String message, Authentication authentication) {
|
||||||
logger.debug("{} {}", authentication.getName(), message);
|
String operator = authentication != null ? authentication.getName() : "anonymous";
|
||||||
|
logger.debug("{} {}", operator, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void log(LogContext context) {
|
||||||
|
if (context.status() == LogContext.SUCCESS) {
|
||||||
|
logger.debug("[操作日志] {} {} {} {} {}", context.operator(), context.httpMethod(),
|
||||||
|
context.requestUrl(), context.ip(), context.message());
|
||||||
|
} else {
|
||||||
|
logger.warn("[操作日志] {} {} {} {} {} 错误: {}", context.operator(), context.httpMethod(),
|
||||||
|
context.requestUrl(), context.ip(), context.message(), context.errorMessage());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,5 +4,16 @@ import org.springframework.security.core.Authentication;
|
|||||||
|
|
||||||
public interface ILogService {
|
public interface ILogService {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 记录日志(旧接口,保持向后兼容)
|
||||||
|
*/
|
||||||
void log(String message, Authentication authentication);
|
void log(String message, Authentication authentication);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 记录日志(新接口,带完整上下文)
|
||||||
|
*/
|
||||||
|
default void log(LogContext context) {
|
||||||
|
// 默认实现:降级到旧接口
|
||||||
|
log(context.message(), null);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,27 @@
|
|||||||
|
package vip.jcfd.log;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 日志上下文,包含操作日志的完整信息
|
||||||
|
*/
|
||||||
|
public record LogContext(
|
||||||
|
String message,
|
||||||
|
String operator,
|
||||||
|
String requestUrl,
|
||||||
|
String httpMethod,
|
||||||
|
String ip,
|
||||||
|
int status,
|
||||||
|
String errorMessage
|
||||||
|
) {
|
||||||
|
/** 操作状态:成功 */
|
||||||
|
public static final int SUCCESS = 0;
|
||||||
|
/** 操作状态:失败 */
|
||||||
|
public static final int FAIL = 1;
|
||||||
|
|
||||||
|
public static LogContext success(String message, String operator, String requestUrl, String httpMethod, String ip) {
|
||||||
|
return new LogContext(message, operator, requestUrl, httpMethod, ip, SUCCESS, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static LogContext fail(String message, String operator, String requestUrl, String httpMethod, String ip, String errorMessage) {
|
||||||
|
return new LogContext(message, operator, requestUrl, httpMethod, ip, FAIL, errorMessage);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,7 +1,9 @@
|
|||||||
package vip.jcfd.log.config;
|
package vip.jcfd.log.config;
|
||||||
|
|
||||||
|
import jakarta.servlet.http.HttpServletRequest;
|
||||||
import org.aspectj.lang.JoinPoint;
|
import org.aspectj.lang.JoinPoint;
|
||||||
import org.aspectj.lang.annotation.AfterReturning;
|
import org.aspectj.lang.annotation.AfterReturning;
|
||||||
|
import org.aspectj.lang.annotation.AfterThrowing;
|
||||||
import org.aspectj.lang.annotation.Aspect;
|
import org.aspectj.lang.annotation.Aspect;
|
||||||
import org.aspectj.lang.annotation.Pointcut;
|
import org.aspectj.lang.annotation.Pointcut;
|
||||||
import org.aspectj.lang.reflect.MethodSignature;
|
import org.aspectj.lang.reflect.MethodSignature;
|
||||||
@@ -12,8 +14,11 @@ import org.springframework.core.annotation.Order;
|
|||||||
import org.springframework.security.core.Authentication;
|
import org.springframework.security.core.Authentication;
|
||||||
import org.springframework.security.core.context.SecurityContextHolder;
|
import org.springframework.security.core.context.SecurityContextHolder;
|
||||||
import org.springframework.stereotype.Component;
|
import org.springframework.stereotype.Component;
|
||||||
|
import org.springframework.web.context.request.RequestContextHolder;
|
||||||
|
import org.springframework.web.context.request.ServletRequestAttributes;
|
||||||
import vip.jcfd.log.ConsoleLogService;
|
import vip.jcfd.log.ConsoleLogService;
|
||||||
import vip.jcfd.log.ILogService;
|
import vip.jcfd.log.ILogService;
|
||||||
|
import vip.jcfd.log.LogContext;
|
||||||
import vip.jcfd.log.annotation.Log;
|
import vip.jcfd.log.annotation.Log;
|
||||||
|
|
||||||
@Configuration("_logConfiguration")
|
@Configuration("_logConfiguration")
|
||||||
@@ -41,10 +46,58 @@ public class LogConfig {
|
|||||||
|
|
||||||
@AfterReturning(value = "logAspect()")
|
@AfterReturning(value = "logAspect()")
|
||||||
public void afterReturning(JoinPoint joinPoint) {
|
public void afterReturning(JoinPoint joinPoint) {
|
||||||
|
LogContext context = buildLogContext(joinPoint, null);
|
||||||
|
logService.log(context);
|
||||||
|
}
|
||||||
|
|
||||||
|
@AfterThrowing(value = "logAspect()", throwing = "ex")
|
||||||
|
public void afterThrowing(JoinPoint joinPoint, Exception ex) {
|
||||||
|
LogContext context = buildLogContext(joinPoint, ex.getMessage());
|
||||||
|
logService.log(context);
|
||||||
|
}
|
||||||
|
|
||||||
|
private LogContext buildLogContext(JoinPoint joinPoint, String errorMessage) {
|
||||||
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
|
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
|
||||||
Log log = signature.getMethod().getAnnotation(Log.class);
|
Log log = signature.getMethod().getAnnotation(Log.class);
|
||||||
|
|
||||||
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
|
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
|
||||||
logService.log(log.value(), authentication);
|
String operator = authentication != null ? authentication.getName() : "anonymous";
|
||||||
|
|
||||||
|
String requestUrl = "";
|
||||||
|
String httpMethod = "";
|
||||||
|
String ip = "";
|
||||||
|
|
||||||
|
ServletRequestAttributes attributes =
|
||||||
|
(ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
|
||||||
|
if (attributes != null) {
|
||||||
|
HttpServletRequest request = attributes.getRequest();
|
||||||
|
requestUrl = request.getRequestURI();
|
||||||
|
httpMethod = request.getMethod();
|
||||||
|
ip = getClientIp(request);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (errorMessage != null) {
|
||||||
|
return LogContext.fail(log.value(), operator, requestUrl, httpMethod, ip, errorMessage);
|
||||||
|
}
|
||||||
|
return LogContext.success(log.value(), operator, requestUrl, httpMethod, ip);
|
||||||
|
}
|
||||||
|
|
||||||
|
private String getClientIp(HttpServletRequest request) {
|
||||||
|
String ip = request.getHeader("X-Forwarded-For");
|
||||||
|
if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
|
||||||
|
ip = request.getHeader("Proxy-Client-IP");
|
||||||
|
}
|
||||||
|
if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
|
||||||
|
ip = request.getHeader("WL-Proxy-Client-IP");
|
||||||
|
}
|
||||||
|
if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
|
||||||
|
ip = request.getRemoteAddr();
|
||||||
|
}
|
||||||
|
// X-Forwarded-For 可能包含多个 IP,取第一个
|
||||||
|
if (ip != null && ip.contains(",")) {
|
||||||
|
ip = ip.split(",")[0].trim();
|
||||||
|
}
|
||||||
|
return ip;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+1
-1
@@ -7,7 +7,7 @@
|
|||||||
<parent>
|
<parent>
|
||||||
<groupId>vip.jcfd</groupId>
|
<groupId>vip.jcfd</groupId>
|
||||||
<artifactId>zkh-framework</artifactId>
|
<artifactId>zkh-framework</artifactId>
|
||||||
<version>1.5.8</version>
|
<version>1.5.12</version>
|
||||||
</parent>
|
</parent>
|
||||||
|
|
||||||
<artifactId>zkh-web</artifactId>
|
<artifactId>zkh-web</artifactId>
|
||||||
|
|||||||
@@ -4,13 +4,11 @@ import jakarta.validation.ConstraintViolationException;
|
|||||||
import jakarta.validation.ValidationException;
|
import jakarta.validation.ValidationException;
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
import org.springframework.http.HttpStatus;
|
|
||||||
import org.springframework.validation.BindException;
|
import org.springframework.validation.BindException;
|
||||||
import org.springframework.validation.BindingResult;
|
import org.springframework.validation.BindingResult;
|
||||||
import org.springframework.validation.FieldError;
|
import org.springframework.validation.FieldError;
|
||||||
import org.springframework.web.bind.MethodArgumentNotValidException;
|
import org.springframework.web.bind.MethodArgumentNotValidException;
|
||||||
import org.springframework.web.bind.annotation.ExceptionHandler;
|
import org.springframework.web.bind.annotation.ExceptionHandler;
|
||||||
import org.springframework.web.bind.annotation.ResponseStatus;
|
|
||||||
import org.springframework.web.bind.annotation.RestControllerAdvice;
|
import org.springframework.web.bind.annotation.RestControllerAdvice;
|
||||||
import org.springframework.web.servlet.resource.NoResourceFoundException;
|
import org.springframework.web.servlet.resource.NoResourceFoundException;
|
||||||
import vip.jcfd.common.core.BizException;
|
import vip.jcfd.common.core.BizException;
|
||||||
@@ -19,7 +17,7 @@ import vip.jcfd.common.core.R;
|
|||||||
import java.util.List;
|
import java.util.List;
|
||||||
|
|
||||||
|
|
||||||
@RestControllerAdvice("_globalExceptionHandler")
|
@RestControllerAdvice
|
||||||
public class GlobalExceptionHandler {
|
public class GlobalExceptionHandler {
|
||||||
|
|
||||||
private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
|
private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
package vip.jcfd.web.config;
|
package vip.jcfd.web.config;
|
||||||
|
|
||||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
|
import jakarta.servlet.DispatcherType;
|
||||||
import jakarta.servlet.ServletException;
|
import jakarta.servlet.ServletException;
|
||||||
import jakarta.servlet.http.HttpServletRequest;
|
import jakarta.servlet.http.HttpServletRequest;
|
||||||
import jakarta.servlet.http.HttpServletResponse;
|
import jakarta.servlet.http.HttpServletResponse;
|
||||||
@@ -10,6 +11,7 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean
|
|||||||
import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
|
import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
|
||||||
import org.springframework.context.annotation.Bean;
|
import org.springframework.context.annotation.Bean;
|
||||||
import org.springframework.context.annotation.Configuration;
|
import org.springframework.context.annotation.Configuration;
|
||||||
|
import org.springframework.core.annotation.Order;
|
||||||
import org.springframework.data.domain.AuditorAware;
|
import org.springframework.data.domain.AuditorAware;
|
||||||
import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
|
import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
|
||||||
import org.springframework.http.HttpHeaders;
|
import org.springframework.http.HttpHeaders;
|
||||||
@@ -110,8 +112,10 @@ public class WebSecurityConfig {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@Bean
|
@Bean
|
||||||
|
@Order
|
||||||
public SecurityFilterChain security(HttpSecurity http, TokenFilter tokenFilter, AuthenticationManager authenticationManager) throws Exception {
|
public SecurityFilterChain security(HttpSecurity http, TokenFilter tokenFilter, AuthenticationManager authenticationManager) throws Exception {
|
||||||
http.authorizeHttpRequests(config -> {
|
http.authorizeHttpRequests(config -> {
|
||||||
|
config.dispatcherTypeMatchers(DispatcherType.ASYNC).permitAll();
|
||||||
config.requestMatchers(securityProps.getIgnoreUrls()).permitAll();
|
config.requestMatchers(securityProps.getIgnoreUrls()).permitAll();
|
||||||
config.anyRequest().authenticated();
|
config.anyRequest().authenticated();
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -0,0 +1,100 @@
|
|||||||
|
package vip.jcfd.web.controller;
|
||||||
|
|
||||||
|
import jakarta.servlet.RequestDispatcher;
|
||||||
|
import jakarta.servlet.http.HttpServletRequest;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
import org.springframework.boot.web.servlet.error.ErrorController;
|
||||||
|
import org.springframework.web.bind.annotation.RequestMapping;
|
||||||
|
import org.springframework.web.bind.annotation.RestController;
|
||||||
|
import vip.jcfd.common.core.R;
|
||||||
|
|
||||||
|
import java.util.Optional;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 自定义错误控制器
|
||||||
|
* 重写 Spring MVC 默认的错误视图,返回 JSON 格式的错误响应
|
||||||
|
*/
|
||||||
|
@RestController
|
||||||
|
public class CustomErrorController implements ErrorController {
|
||||||
|
|
||||||
|
private static final Logger log = LoggerFactory.getLogger(CustomErrorController.class);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 处理错误请求
|
||||||
|
* 根据 HTTP 状态码返回相应的错误信息
|
||||||
|
*/
|
||||||
|
@RequestMapping("/error")
|
||||||
|
public R<?> handleError(HttpServletRequest request) {
|
||||||
|
// 获取状态码
|
||||||
|
int status = Optional.ofNullable(request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE))
|
||||||
|
.map(Object::toString)
|
||||||
|
.map(Integer::parseInt)
|
||||||
|
.orElse(500);
|
||||||
|
|
||||||
|
// 获取请求 URI
|
||||||
|
String requestUri = Optional.ofNullable(request.getAttribute(RequestDispatcher.ERROR_REQUEST_URI))
|
||||||
|
.map(Object::toString)
|
||||||
|
.orElse("unknown");
|
||||||
|
|
||||||
|
// 获取异常信息
|
||||||
|
String exceptionMessage = Optional.ofNullable(request.getAttribute(RequestDispatcher.ERROR_MESSAGE))
|
||||||
|
.map(Object::toString)
|
||||||
|
.orElse(null);
|
||||||
|
|
||||||
|
// 获取异常类型
|
||||||
|
String exceptionType = Optional.ofNullable(request.getAttribute(RequestDispatcher.ERROR_EXCEPTION_TYPE))
|
||||||
|
.map(Object::toString)
|
||||||
|
.orElse(null);
|
||||||
|
|
||||||
|
// 获取异常对象
|
||||||
|
Throwable throwable = Optional.ofNullable(request.getAttribute(RequestDispatcher.ERROR_EXCEPTION))
|
||||||
|
.filter(Throwable.class::isInstance)
|
||||||
|
.map(Throwable.class::cast)
|
||||||
|
.orElse(null);
|
||||||
|
|
||||||
|
// 记录错误日志
|
||||||
|
if (status >= 500) {
|
||||||
|
log.error("服务器错误 - 状态码: {}, 请求路径: {}, 异常类型: {}, 异常信息: {}",
|
||||||
|
status, requestUri, exceptionType, exceptionMessage, throwable);
|
||||||
|
} else if (status >= 400) {
|
||||||
|
log.warn("客户端错误 - 状态码: {}, 请求路径: {}, 异常信息: {}",
|
||||||
|
status, requestUri, exceptionMessage);
|
||||||
|
}
|
||||||
|
|
||||||
|
// 根据状态码获取友好的错误消息
|
||||||
|
String errorMessage = getErrorMessage(status, exceptionMessage);
|
||||||
|
|
||||||
|
return new R<>(status, errorMessage, false, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 根据状态码获取友好的错误消息
|
||||||
|
*/
|
||||||
|
private String getErrorMessage(int status, String originalMessage) {
|
||||||
|
if (originalMessage != null && !originalMessage.isEmpty()) {
|
||||||
|
return originalMessage;
|
||||||
|
}
|
||||||
|
|
||||||
|
return switch (status) {
|
||||||
|
case 400 -> "请求参数错误";
|
||||||
|
case 401 -> "未授权,请先登录";
|
||||||
|
case 403 -> "无权访问";
|
||||||
|
case 404 -> "您访问的地址不存在";
|
||||||
|
case 405 -> "请求方法不支持";
|
||||||
|
case 500 -> "服务器内部错误";
|
||||||
|
case 502 -> "网关错误";
|
||||||
|
case 503 -> "服务暂时不可用";
|
||||||
|
case 504 -> "网关超时";
|
||||||
|
default -> "请求失败";
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 返回错误路径
|
||||||
|
* 实现 ErrorController 接口要求
|
||||||
|
*/
|
||||||
|
public String getErrorPath() {
|
||||||
|
return "/error";
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user