【Spring-boot-route（十七）使用aop记录操作日志+（十八）Spring-boot-adtuator监控应用】

时间：2023-02-15 11:21:14

前言：

使用文件存储日志用来快速查询问题并不是最方便的，一个优秀系统除了日志文件还需要将操作日志进行持久化，来监控平台的操作记录。今天我们一起来学习一下如何通过apo来记录日志。

为了让记录日志更加灵活，我们将使用自定义的注解来实现重要操作的日志记录功能。


一 日志记录表

日志记录表主要包含几个字段，业务模块，操作类型，接口地址，处理状态，错误信息以及操作时间。数据库设计如下：

CREATE TABLE `sys_oper_log` (
   `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '日志主键',
   `title` varchar(50) CHARACTER SET utf8 DEFAULT '' COMMENT '模块标题',
   `business_type` int(2) DEFAULT '0' COMMENT '业务类型（0其它 1新增 2修改 3删除）',
   `method` varchar(255) CHARACTER SET utf8 DEFAULT '' COMMENT '方法名称',
   `status` int(1) DEFAULT '0' COMMENT '操作状态（0正常 1异常）',
   `error_msg` varchar(2000) CHARACTER SET utf8 DEFAULT '' COMMENT '错误消息',
   `oper_time` datetime DEFAULT NULL COMMENT '操作时间',
   PRIMARY KEY (`id`)
) ENGINE=InnoDB CHARSET=utf8mb4 CHECKSUM=1 COMMENT='操作日志记录'

对应的实体类如下：

@Data
@NoArgsConstructor
@AllArgsConstructor
public class SysOperLog implements Serializable {
private static final long serialVersionUID = 1L;

/** 日志主键 */
private Long id;

/** 操作模块 */
private String title;

/** 业务类型（0其它 1新增 2修改 3删除） */
private Integer businessType;

/** 请求方法 */
private String method;

/** 错误消息 */
private String errorMsg;

private Integer status;

/** 操作时间 */
private Date operTime;
}


二 自定义注解及处理

自定义注解包含两个属性，一个是业务模块​​title​​，另一个是操作类型​​businessType​​。


@Target({ ElementType.PARAMETER, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {
/**
* 模块
*/
String title() default "";

/**
* 功能
*/
BusinessType businessType() default BusinessType.OTHER;
}

使用aop对自定义的注解进行处理


@Aspect
@Component
@Slf4j
public class LogAspect {

@Autowired
private AsyncLogService asyncLogService;

// 配置织入点
@Pointcut("@annotation(com.javatrip.aop.annotation.Log)")
public void logPointCut() {}

/**
* 处理完请求后执行
*
* @param joinPoint 切点
*/
@AfterReturning(pointcut = "logPointCut()", returning = "jsonResult")
public void doAfterReturning(JoinPoint joinPoint, Object jsonResult) {
handleLog(joinPoint, null, jsonResult);
    }

/**
* 拦截异常操作
* 
* @param joinPoint 切点
* @param e 异常
*/
@AfterThrowing(value = "logPointCut()", throwing = "e")
public void doAfterThrowing(JoinPoint joinPoint, Exception e) {
handleLog(joinPoint, e, null);
    }

protected void handleLog(final JoinPoint joinPoint, final Exception e, Object jsonResult) {
try {
// 获得注解
Log controllerLog = getAnnotationLog(joinPoint);
if (controllerLog == null) {
return;
            }

SysOperLog operLog = new SysOperLog();
operLog.setStatus(0);
if (e != null) {
operLog.setStatus(1);
operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));
            }
// 设置方法名称
String className = joinPoint.getTarget().getClass().getName();
String methodName = joinPoint.getSignature().getName();
operLog.setMethod(className + "." + methodName + "()");
// 处理设置注解上的参数
getControllerMethodDescription(joinPoint, controllerLog, operLog);
// 保存数据库
asyncLogService.saveSysLog(operLog);
        } catch (Exception exp) {
log.error("==前置通知异常==");
log.error("日志异常信息 {}", exp);
        }
    }

/**
* 获取注解中对方法的描述信息 用于Controller层注解
* 
* @param log 日志
* @param operLog 操作日志
* @throws Exception
*/
public void getControllerMethodDescription(JoinPoint joinPoint, Log log, SysOperLog operLog) {
// 设置action动作
operLog.setBusinessType(log.businessType().ordinal());
// 设置标题
operLog.setTitle(log.title());
    }

/**
* 是否存在注解，如果存在就获取
*/
private Log getAnnotationLog(JoinPoint joinPoint) {
Signature signature = joinPoint.getSignature();
MethodSignature methodSignature = (MethodSignature) signature;
Method method = methodSignature.getMethod();
if (method != null) {
return method.getAnnotation(Log.class);
        }
return null;
    }
}

操作类型的枚举类：


public enum BusinessType {
/**
* 其它
*/
OTHER,

/**
* 新增
*/
INSERT,

/**
* 修改
*/
UPDATE,

/**
* 删除
*/
DELETE,
}

使用异步方法将操作日志存库，为了方便我直接使用jdbcTemplate在service中进行存库操作。


@Service
public class AsyncLogService {

@Autowired
private JdbcTemplate jdbcTemplate;

/**
* 保存系统日志记录
*/
@Async
public void saveSysLog(SysOperLog log) {

String sql = "INSERT INTO sys_oper_log(title,business_type,method,STATUS,error_msg,oper_time) VALUES(?,?,?,?,?,?)";
jdbcTemplate.update(sql,new Object[]{log.getTitle(),log.getBusinessType(),log.getMethod(),log.getStatus(),log.getErrorMsg(),new Date()});
    }
}

三 编写接口测试

将自定义注解写在业务方法上，测试效果


@RestController
@RequestMapping("person")
public class PersonController {
@GetMapping("/{name}")
@Log(title = "system",businessType = BusinessType.OTHER)
public Person getPerson(@PathVariable("name") String name, @RequestParam int age){
return new Person(name,age);
    }

@PostMapping("add")
@Log(title = "system",businessType = BusinessType.INSERT)
public int addPerson(@RequestBody Person person){
if(StringUtils.isEmpty(person)){
return -1;
        }
return 1;
    }

@PutMapping("update")
@Log(title = "system",businessType = BusinessType.UPDATE)
public int updatePerson(@RequestBody Person person){
if(StringUtils.isEmpty(person)){
return -1;
        }
return 1;
    }

@DeleteMapping("/{name}")
@Log(title = "system",businessType = BusinessType.DELETE)
public int deletePerson(@PathVariable(name = "name") String name){
if(StringUtils.isEmpty(name)){
return -1;
        }
return 1;
    }
}

当然，还可以在数据库中将请求参数和响应结果也进行存储，这样就能看出具体接口的操作记录了。



》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》


接下来讲解：

【spring-boot-route（十八）spring-boot-adtuator监控应用】

Spring Boot提供了良好的服务监控模块，只需要通过简单的配置便可以完成服务监控和管理。但是服务监控这块内容往往是最容易被忽略的一块内容，今天我们一起来学习一下使用​​spring-boot-actuator​​​进行服务监控。​​spring-boot-actuator​​​提供了监控端点，这些端点直接返回​​JSON字符串​​，通过这些端点可以查询服务运行状况，为了防止端点直接暴露，一般情况下会使用安全框架，如Spring Security来管理这些端点的安全性。


一 常用的端点

端点地址

描述

默认启用

auditevents

获取当前应用暴露的审计事件信息

是

beans

获取应用中所有的bean的完整关系列表

是

caches

获取公开可以用的缓存

是

conditions

获取自动配置条件信息，记录哪些自动配置条件通过和没通过的原因

是

configprops

获取所有配置属性，包括默认配置，显示一个所有 @ConfigurationProperties 的整理列版本

是

env

获取所有环境变量

是

flyway

获取已应用的所有Flyway数据库迁移信息，需要一个或多个 Flyway Bean

是

health

获取应用程序健康指标（运行状况信息）

是

httptrace

获取HTTP跟踪信息（默认情况下，最近100个HTTP请求-响应交换）。需要 HttpTraceRepository Bean

是

info

获取应用程序信息

是

integrationgraph

显示 Spring Integration 图。需要依赖 spring-integration-core

是

loggers

显示和修改应用程序中日志的配置

是

liquibase

获取应用的所有Liquibase数据库迁移。需要一个或多个 Liquibase Bean

是

metrics

获取系统度量指标信息

是

mappings

显示所有@RequestMapping路径的整理列表

是

scheduledtasks

显示应用程序中的计划任务

是

sessions

允许从Spring Session支持的会话存储中检索和删除用户会话。需要使用Spring Session的基于Servlet的Web应用程序

是

shutdown

关闭应用

否

threaddump

获取系统线程转储信息

是

默认情况下，除了​​shutdown​​，其他端点都是启动状态。


1.1 如何使用

在项目中引入​​spring-boot-actuator​​的依赖，就可以正常使用了

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

1.2 如何访问

/actuator+端点地址


1.3 端点开启/关闭

management:
  endpoint:
    # 开启shutdown端点
    shutdown:
      enabled: true

启用/禁用所有端点


management:
  endpoints:
    enabled-by-default: true

1.4 端点暴露

默认情况下，只有​​health​​和​​info​​暴露了http端口，这些端点支持通过​​http​​和​​JMX​​访问，如果需要访问具体的端点则需要配置暴露。

暴露​​http​​端点

management:
  endpoints:
    web:
      exposure:
        include: health,info

暴露​​JMX​​端点

management:
  endpoints:
    jmx:
      exposure:
        include: health,info


二 常用端点解析

2.1 health

​​health​​包含的健康检查项有​​DataSourceHealthIndicator​​，​​DiskSpaceHealthIndicator​​，​​MongoHealthIndicator​​，​​ReidsHealthIndicator​​，​​CassandraHealthIndicator​​。

关闭特定的检查项配置如下，关闭redis检查项：

management:
  health:
    redis:
      enabled: false

默认情况下health只是简单的展示了​​UP​​和​​DOWN​​两种状态，如果想要看详细信息，则需要配置

management:
  endpoint:
    health:
      show-details: always

2.2 metrics

​​metrics​​​可以使用带PathVariable参数，参数为具体的度量值，如查看cpu大小

2.3 info

​​info​​使用的时候需要在配置文件中自定义信息，自定义信息以​​info​​开头。

例如在配置文件中增加如下内容：


info:
  person:
    name: Java旅途
    age: 18

访问​​info​​端点显示的是去掉info的一个JSON串：

【Spring-boot-route（十七）使用aop记录操作日志+（十八）Spring-boot-adtuator监控应用】

​​Spring-Boot-acturator​​使用起来很方便，但是缺点也很明显，就是没有图形化界面。使用起来也不是很友好，下一章中，我们将使用有图形化的​​Spring-Boot-Admin​​来进行服务监控。


标签：

相关文章