文章目录

• 一、前言
• 二、操作日志开发
• • 1、新建实体类
  • 2、新建OperationLogService.java
  • 3、新建OperationLogServiceImpl.java
  • 4、新建OperationLogMapper.java
  • 5、新建OperationLogMapper.xml文件
• 三、开发注解
• • 1、OperationType.java
  • 2、OperationLogSys.java
  • 3、OptLogAspect.java
  • 4、添加注解
• 四、登录日志
• • 1、建表语句
  • 2、实体类
  • 3、业务类
  • 4、数据接口Mapper
  • 5、xml文件
  • 6、接口层
  • 7、登录日志编写
  • • 1、添加maven
    • 2、客户端工具类
    • 8、测试

一、前言

我们后端的功能差不多写的可以了，我看了下还差了个操作日志和登录日志，我们今天就将这个实现一下，然后后端就基本上完成了，再完成前端的页面我们的项目就完成了，可能大家注意到了我把项目的标题都改了，没有了移动端，我考虑到现在我们就先做前后台功能，后期我们再进行用户端的开发，等我更新完基础的知识。

最近我看没有人看，也没有太大的动力了，可能大家受疫情影响都在忙，大家做好防护，春天已经到来，疫情终将散去，我们努力拼搏!

二、操作日志开发

我们开始开发操作日志功能，首先我们要思考，我们操作日志是干嘛的？怎么能获取到操作日志？我们怎么知道谁操作的什么功能？接下来我们一点点的开发。

由于时间比较长了 ，一开始建立的数据有点改变，大家把下面的sql重新再Navicat里的查询里再运行一遍，更新下操作日志的数据。

DROP TABLE IF EXISTS `person_operation_log`;CREATE TABLE `person_operation_log` (  `id`      INT      NOT NULL PRIMARY KEY AUTO_INCREMENT     COMMENT '主键',  `operation_ip`   VARCHAR(128) NULL DEFAULT 0 COMMENT '主机地址',  `opera_location` VARCHAR(255) NULL DEFAULT ''COMMENT '操作地点',  `methods` TEXT  NULL    COMMENT '方法名',  `args`     TEXT  NULL    COMMENT '请求参数',  `operation_name` VARCHAR(50)     NOT NULL DEFAULT ''COMMENT '操作人',  `operation_type`   VARCHAR(50)     NOT NULL DEFAULT ''COMMENT '操作类型',  `return_value`     TEXT  NULL    COMMENT '返回参数',  `create_time`   DATETIME     NULL DEFAULT CURRENT_TIMESTAMP      COMMENT '创建时间') ENGINE = InnoDB  CHARACTER SET = utf8mb4  COLLATE = utf8mb4_bin  ROW_FORMAT = Dynamic  COMMENT '操作日志表';

更新完表之后，我们接下来写操作日志的添加功能，这儿大家看到这里可以停止往下看了，自己去写一下操作日志的添加，我们写了那么多次了，要自己尝试，我们教程都快结束了再不会写就说不过去了。

1、新建实体类

在entity包中新建一个OperationLog.java类

package com.blog.personalblog.entity;import lombok.Data;import java.time.LocalDateTime;/** * @author: SuperMan * @create: 2022-04-02 **/@Datapublic class OperationLog {    /**     * 主键id     */    private Integer id;    /**     * ip地址     */    private String operationIp;    /**     * ip来源     */    private String operaLocation;    /**     * 操作方法名     */    private String methods;    /**     * 请求参数     */    private String args;    /**     * 操作人     */    private String operationName;    /**     * 操作类型     */    private String operationType;    /**     * 返回结果     */    private String returnValue;    /**     * 创建时间     */    private LocalDateTime createTime;}

2、新建OperationLogService.java

新建一个业务类接口，然后写一个添加和查询的接口，操作日志只能展示，不能删除和修改。

package com.blog.personalblog.service;import com.blog.personalblog.config.page.PageRequest;import com.blog.personalblog.entity.OperationLog;import java.util.List;/** * @author: SuperMan * @create: 2022-04-02 **/public interface OperationLogService {    /**     * 保存操作日志     *     * @param operationLog     * @return     */    void saveOperationLog(OperationLog operationLog);    /**     * 操作日志列表（分页）     *     * @param pageRequest     * @return     */    List<OperationLog> getOperationLogPage(PageRequest pageRequest);}

3、新建OperationLogServiceImpl.java

新建一个业务的实现类，实现那两个接口。

package com.blog.personalblog.service.Impl;import com.blog.personalblog.config.page.PageRequest;import com.blog.personalblog.entity.OperationLog;import com.blog.personalblog.mapper.OperationLogMapper;import com.blog.personalblog.service.OperationLogService;import com.github.pagehelper.PageHelper;import org.springframework.stereotype.Service;import javax.annotation.Resource;import java.util.List;/** * @author: SuperMan * @create: 2022-04-02 **/@Servicepublic class OperationLogServiceImpl implements OperationLogService {    @Resource    OperationLogMapper operationLogMapper;    @Override    public void saveOperationLog(OperationLog operationLog) { operationLogMapper.createOperationLog(operationLog);    }    @Override    public List<OperationLog> getOperationLogPage(PageRequest pageRequest) { int pageNum = pageRequest.getPageNum(); int pageSize = pageRequest.getPageSize(); PageHelper.startPage(pageNum,pageSize); List<OperationLog> operationLogList = operationLogMapper.getOperationLogPage(); return operationLogList;    }}

然后我们写dao层的接口。

4、新建OperationLogMapper.java

这个也不用多说了，新写两个添加和查找的接口。

package com.blog.personalblog.mapper;import com.blog.personalblog.entity.OperationLog;import org.springframework.stereotype.Repository;import java.util.List;/** * @author: SuperMan * @create: 2022-04-02 **/@Repositorypublic interface OperationLogMapper {    /**     * 创建操作日志     * @param operationLog     * @return     */    int createOperationLog(OperationLog operationLog);    /**     * 分类列表（分页）     * @return     */    List<OperationLog> getOperationLogPage();}

5、新建OperationLogMapper.xml文件

<?xml version="1.0" encoding="UTF-8" ?><!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="com.blog.personalblog.mapper.OperationLogMapper">    <resultMap id="BaseResultMap" type="com.blog.personalblog.entity.OperationLog"> <result column="id" jdbcType="INTEGER" property="id"/> <result column="operation_ip" jdbcType="VARCHAR" property="operationIp"/> <result column="opera_location" jdbcType="VARCHAR" property="operaLocation"/> <result column="methods" jdbcType="VARCHAR" property="methods"/> <result column="args" jdbcType="VARCHAR" property="args"/> <result column="operation_name" jdbcType="VARCHAR" property="operationName"/> <result column="operation_type" jdbcType="VARCHAR" property="operationType"/> <result column="return_value" jdbcType="VARCHAR" property="returnValue"/> <result column="create_time" jdbcType="VARCHAR" property="createTime"/>    </resultMap>    <insert id="createOperationLog" parameterType="com.blog.personalblog.entity.OperationLog" useGeneratedKeys="true" keyProperty="id"> INSERT INTO person_operation_log (operation_ip, opera_location, methods, args, operation_name, operation_type, return_value) VALUES(#{operationIp}, #{operaLocation}, #{methods}, #{args}, #{operationName}, #{operationType}, #{returnValue})    </insert>    <select id="getOperationLogPage" resultMap="BaseResultMap"> select * from person_operation_log    </select></mapper>

上边写了那么多，基本上把操作日志的功能写完了，我们现在有了存储操作日志的数据了，也能查出来了，现在是要考虑如何把操作日志的数据获取。
接下来我们要放大招，手写注解，以前都是我们使用别人的注解，现在我们要自己写注解。

三、开发注解

我们使用AOP切面的方式来实现日志记录功能。但是什么是AOP呢？

在软件业，AOP为Aspect Oriented Programming的缩写，意为：面向切面编程，通过预编译方
式和运行期动态代理实现程序功能的统一维护的一种技术。AOP是OOP的延续，是软件开发中的一个
热点，也是Spring框架中的一个重要内容，是函数式编程的一种衍生范型。利用AOP可以对业务逻辑
的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高
了开发的效率。

我们先看一下AOP包含的概念

1. Aspect（切面）： Aspect 声明类似于 Java 中的类声明，在 Aspect 中会包含着一些 Pointcut 以及相应的 Advice。
2. Joint point（连接点）：表示在程序中明确定义的点，典型的包括方法调用，对类成员的访问以及异常处理程序块的执行等等，它自身还可以嵌套其它 joint point。
3. Pointcut（切点）：表示一组 joint point，这些 joint point 或是通过逻辑关系组合起来，或是通过通配、正则表达式等方式集中起来，它定义了相应的 Advice 将要发生的地方。
4. Advice（增强）：Advice 定义了在 Pointcut 里面定义的程序点具体要做的操作，它通过 before、after 和 around 来区别是在每个 joint point 之前、之后还是代替执行的代码。
5. Target（目标对象）：织入 Advice 的目标对象.。
6. Weaving（织入）：将 Aspect 和其他对象连接起来, 并创建 Adviced object 的过程

1、OperationType.java

接下来我们要编写注解了，首先创建一个annotation包和handler包，主要放AOP切点类和自定义注解类，我们在annotation包中先创建一个OperationType.java枚举类。这个类主要是放注解使用的枚举类型。

package com.blog.personalblog.annotation;import lombok.Getter;/** * 操作类型 * * @author: SuperMan * @create: 2022-04-02 **/@Getterpublic enum OperationType {    /**     * 默认系统     */    SYSTEM("SYSTEM"),    /**     * 登录     */    LOGIN("LOGIN"),    /**     * 添加     */    INSERT("INSERT"),    /**     * 删除     */    DELETE("DELETE"),    /**     * 查询     */    SELECT("SELECT"),    /**     * 更新     */    UPDATE("UPDATE");    private String value;    OperationType(String s) { this.value = s;    }}

2、OperationLogSys.java

接下来我们自定义注解，OperationLogSys这个就是我们定义的注解名@OperationLogSys，然后下面两个接口就是我们使用注解后边带的参数，接下来我们再讲解一下。

package com.blog.personalblog.annotation;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/** * 操作日志注解 * * @author: SuperMan * @create: 2022-04-02 **/@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface OperationLogSys {    /**     * 日志描述     */    String desc() default "";    /**     * 日志操作类型     */    OperationType operationType() default OperationType.SYSTEM;}

• @Target
  作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）
  取值(ElementType)有：
  a. CONSTRUCTOR：用于描述构造器
  b. FIELD：用于描述域
  c. LOCAL_VARIABLE：用于描述局部变量
  d. METHOD：用于描述方法
  e. PACKAGE：用于描述包
  f. PARAMETER：用于描述参数
  g. TYPE：用于描述类、接口(包括注解类型) 或enum声明。
• @Retention
  作用是定义被它所注解的注解保留多久，一共有三种策略：
  a. source：注解只保留在源文件，当Java文件编译成class文件的时候，注解被遗弃；被编译器忽略。
  b. class：注解被保留到class文件，但jvm加载class文件时候被遗弃，这是默认的生命周期。
  c. runtime：注解不仅被保存到class文件中，jvm加载class文件之后，仍然存在。

首先要明确生命周期长度 SOURCE < CLASS < RUNTIME ，所以前者能作用的地方后者一定也能作用。一般如果需要在运行时去动态获取注解信息，那只能用 RUNTIME 注解；如果要在编译时进行一些预处理操作，比如生成一些辅助代码（如 ButterKnife），就用 CLASS注解；如果只是做一些检查性的操作，比如 @Override 和 @SuppressWarnings，则可选用 SOURCE 注解。

• @Documented
  用来标注生成javadoc的时候是否会被记录。

3、OptLogAspect.java

接下来是我们最主要的类，可以使用自定义注解或针对包名实现AOP增强。
在handler包中新建OptLogAspect.java
1、Pointcut(切入点)： JoinPoint的集合，是程序中需要注入Advice的位置的集合，指明Advice要在什么样的条件下才能被触发，在程序中主要体现为书写切入点表达式。

    /**     * 日志 切面 自定义注解  切到任意方法     */    @Pointcut("@annotation(com.blog.personalblog.annotation.OperationLogSys)")    public void optLog() {    }

2、标识一个前置增强方法，相当于BeforeAdvice的功能。

 @Before("optLog()") public void doBefore(JoinPoint joinPoint) {     log.info("进入方法前执行..."); }

3、接下来我们就开始获取到注解的操作数据。具体的下面代码都有注释，这里我只说JoinPoint类和@AfterReturning注解。

JoinPoint常用的方法：

• Object[] getArgs：返回目标方法的参数
• Signature getSignature：返回目标方法的签名
• Object getTarget：返回被织入增强处理的目标对象
• Object getThis：返回AOP框架为目标对象生成的代理对象

@AfterReturning注解可指定如下两个常用属性：

• pointcut/value:这两个属性的作用是一样的，它们都属于指定切入点对应的切入表达式。一样既可以是已有的切入点，也可直接定义切入点表达式。当指定了pointcut属性值后，value属性值将会被覆盖。
• returning:该属性指定一个形参名，用于表示Advice方法中可定义与此同名的形参，该形参可用于访问目标方法的返回值。除此之外，在Advice方法中定义该形参（代表目标方法的返回值）时指定的类型，会限制目标方法必须返回指定类型的值或没有返回值。

    @Async    @Transactional(rollbackFor = Exception.class)    @AfterReturning(value = "optLog()", returning = "result")    public void doAfterReturning(JoinPoint joinPoint, Object result) throws Throwable { // 获取RequestAttributes RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes(); // 从获取RequestAttributes中获取HttpServletRequest的信息 HttpServletRequest request = (HttpServletRequest) Objects.requireNonNull(requestAttributes).resolveReference(RequestAttributes.REFERENCE_REQUEST); // 从切面织入点处通过反射机制获取织入点处的方法 MethodSignature signature = (MethodSignature) joinPoint.getSignature(); OperationLogSys annotation = signature.getMethod().getAnnotation(OperationLogSys.class); // 获取切入点所在的方法 Method method = signature.getMethod(); OperationLog operationLog = new OperationLog(); if (annotation != null) {     //操作类型     String operationType = annotation.operationType().getValue();     operationLog.setOperationType(operationType);     //IP地址     String ipAddr = IpUtil.getIpAddr(request);     operationLog.setOperationIp(ipAddr);     //IP来源     operationLog.setOperaLocation(IpUtil.getIpInfo(ipAddr));     //操作人     String userName = request.getRemoteUser();     operationLog.setOperationName(userName);     //操作方法名     String className = joinPoint.getTarget().getClass().getName();     String methodName = method.getName();     methodName = className + "." + methodName;     operationLog.setMethods(methodName);     //参数     operationLog.setArgs(JSON.toJSONString(joinPoint.getArgs()));     //返回结果     operationLog.setReturnValue(JSON.toJSONString(result));     operationLogService.saveOperationLog(operationLog); }    }

以下是全部的代码：

package com.blog.personalblog.handler;import com.alibaba.fastjson.JSON;import com.blog.personalblog.annotation.OperationLogSys;import com.blog.personalblog.entity.OperationLog;import com.blog.personalblog.service.OperationLogService;import com.blog.personalblog.util.IpUtil;import lombok.extern.slf4j.Slf4j;import org.aspectj.lang.JoinPoint;import org.aspectj.lang.annotation.AfterReturning;import org.aspectj.lang.annotation.Aspect;import org.aspectj.lang.annotation.Before;import org.aspectj.lang.annotation.Pointcut;import org.aspectj.lang.reflect.MethodSignature;import org.springframework.scheduling.annotation.Async;import org.springframework.stereotype.Component;import org.springframework.transaction.annotation.Transactional;import org.springframework.web.context.request.RequestAttributes;import org.springframework.web.context.request.RequestContextHolder;import javax.annotation.Resource;import javax.servlet.http.HttpServletRequest;import java.lang.reflect.Method;import java.util.Objects;/** * 操作日志切面 * * @author: SuperMan * @create: 2022-04-02 **/@Slf4j@Aspect@Componentpublic class OptLogAspect {    @Resource    private OperationLogService operationLogService;    /**     * 日志 切面 自定义注解  切到任意方法     */    @Pointcut("@annotation(com.blog.personalblog.annotation.OperationLogSys)")    public void optLog() {    }    @Before("optLog()")    public void doBefore(JoinPoint joinPoint) { log.info("进入方法前执行...");    }    @Async    @Transactional(rollbackFor = Exception.class)    @AfterReturning(value = "optLog()", returning = "result")    public void doAfterReturning(JoinPoint joinPoint, Object result) throws Throwable { // 获取RequestAttributes RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes(); // 从获取RequestAttributes中获取HttpServletRequest的信息 HttpServletRequest request = (HttpServletRequest) Objects.requireNonNull(requestAttributes).resolveReference(RequestAttributes.REFERENCE_REQUEST); // 从切面织入点处通过反射机制获取织入点处的方法 MethodSignature signature = (MethodSignature) joinPoint.getSignature(); OperationLogSys annotation = signature.getMethod().getAnnotation(OperationLogSys.class); // 获取切入点所在的方法 Method method = signature.getMethod(); OperationLog operationLog = new OperationLog(); if (annotation != null) {     //操作类型     String operationType = annotation.operationType().getValue();     operationLog.setOperationType(operationType);     //IP地址     String ipAddr = IpUtil.getIpAddr(request);     operationLog.setOperationIp(ipAddr);     //IP来源     operationLog.setOperaLocation(IpUtil.getIpInfo(ipAddr));     //操作人     String userName = request.getRemoteUser();     operationLog.setOperationName(userName);     //操作方法名     String className = joinPoint.getTarget().getClass().getName();     String methodName = method.getName();     methodName = className + "." + methodName;     operationLog.setMethods(methodName);     //参数     operationLog.setArgs(JSON.toJSONString(joinPoint.getArgs()));     //返回结果     operationLog.setReturnValue(JSON.toJSONString(result));     operationLogService.saveOperationLog(operationLog); }    }}

4、添加注解

下面我们写完了注解，接下来我们肯定要使用这个注解，但是在什么地方引用呢，当然在我们程序的入库，那就是Controller层，这个是前端操作第一个进来的入口。
例如：我们在分类的Controller中添加分类的方法上添加一个注解。

@OperationLogSys(desc = "添加分类", operationType = OperationType.INSERT)

完整代码：

  /**     * 添加分类     * @return     */    @ApiOperation(value = "添加分类")    @PostMapping("/create")    @OperationLogSys(desc = "添加分类", operationType = OperationType.INSERT)    public JsonResult<Object> categoryCreate(@RequestBody @Valid Category category) { int isStatus = categoryService.saveCategory(category); if (isStatus == 0) {     return JsonResult.error("添加分类失败"); } return JsonResult.success();    }

我们先测试一下这个注解是否有用，操作数据是否保存到了数据中。
打开postman，因为我们上一篇加了登录验证，所以我们在操作其他接口时，要先登录，重启项目之后也要重新登录。
我们先进行登录：

登录成功之后，然后我们打开添加分类的接口，新添加一个分类。

看着添加成功了，我们去看下数据库，操作日志有没有数据。看到有数据，也是我们添加的分类，就说明我们添加成功了。

好啦，我只添加一个操作日志，大家把所有的增加、删除、修改都进行添加一下，查询数据比较多可加可不加。
接下来我们写一下操作日志，操作日志就比较简单啦，不用写注解啦，直接添加即可。

四、登录日志

接下来我们写一下登录日志，我们只需要再登录的接口的地方写一个插入登录操作的日志即可，由于我们设计的登录日志和操作日志是两张表，所以我们还得写一套登录日志的CRDU操作，废话不多说，开整。
下面我直接写了，大家应该可以看懂。

1、建表语句

DROP TABLE IF EXISTS `person_login_log`;CREATE TABLE `person_login_log` (  `id`  BIGINT(20)  NOT NULL PRIMARY KEY AUTO_INCREMENT    COMMENT '登录访问id',  `login_name`VARCHAR(50)     NULLDEFAULT ''  COMMENT '登录账号',  `ip_address` VARCHAR(128)    NULLDEFAULT ''  COMMENT '登录IP地址',  `login_location`    VARCHAR(255)   NULLDEFAULT ''  COMMENT '登录地点',  `browser_type`      VARCHAR(50)    NULLDEFAULT ''  COMMENT '浏览器类型',  `os` VARCHAR(50)    NULL     DEFAULT ''  COMMENT '操作系统',  `login_status`      TINYINT NULL     DEFAULT 0 COMMENT '登录状态，默认0, 0-成功, 1-失败',  `create_time`DATETIME      NULL     DEFAULT CURRENT_TIMESTAMPCOMMENT '创建时间') ENGINE = InnoDB  CHARACTER SET = utf8mb4  COLLATE = utf8mb4_bin  ROW_FORMAT = Dynamic  COMMENT '登录日志表';

2、实体类

新建一个LoginOperationLog.java类

package com.blog.personalblog.entity;import lombok.Data;import java.time.LocalDateTime;/** * @author: SuperMan * @create: 2022-04-05 **/@Datapublic class LoginOperationLog {    /**     * 主键id     */    private Integer id;    /**     * 登录账号     */    private String loginName;    /**     * 登录IP地址     */    private String ipAddress;    /**     * 登录地点     */    private String loginLocation;    /**     * 浏览器类型     */    private String browserType;    /**     * 操作系统     */    private String os;    /**     * 登录状态，默认0, 0-成功, 1-失败     */    private Integer loginStatus;    /**     * 创建时间     */    private LocalDateTime createTime;}

3、业务类

（1）新建一个LoginOperationLogService.java业务接口类

package com.blog.personalblog.service;import com.blog.personalblog.config.page.PageRequest;import com.blog.personalblog.entity.LoginOperationLog;import java.util.List;/** * @author: SuperMan * @create: 2022-04-05 **/public interface LoginOperationLogService {    /**     * 添加登录日志     *     * @param loginOperationLog     * @return     */    void saveOperationLog(LoginOperationLog loginOperationLog);    /**     * 登录日志列表（分页）     *     * @param pageRequest     * @return     */    List<LoginOperationLog> getLoginOperationLogPage(PageRequest pageRequest);}

（2）新建一个LoginOperationLogServiceImpl.java业务实现类

package com.blog.personalblog.service.Impl;import com.blog.personalblog.config.page.PageRequest;import com.blog.personalblog.entity.LoginOperationLog;import com.blog.personalblog.mapper.LoginOperationLogMapper;import com.blog.personalblog.service.LoginOperationLogService;import com.github.pagehelper.PageHelper;import org.springframework.stereotype.Service;import javax.annotation.Resource;import java.util.List;/** * * @author: SuperMan * @create: 2022-04-05 **/@Servicepublic class LoginOperationLogServiceImpl implements LoginOperationLogService {    @Resource    private LoginOperationLogMapper loginOperationLogMapper;    @Override    public void saveOperationLog(LoginOperationLog loginOperationLog) { loginOperationLogMapper.createLoginOperationLog(loginOperationLog);    }    @Override    public List<LoginOperationLog> getLoginOperationLogPage(PageRequest pageRequest) { int pageNum = pageRequest.getPageNum(); int pageSize = pageRequest.getPageSize(); PageHelper.startPage(pageNum,pageSize); List<LoginOperationLog> loginOperationLogList = loginOperationLogMapper.getLoginOperationLogPage(); return loginOperationLogList;    }}

4、数据接口Mapper

新建一个LoginOperationLogMapper.java接口

package com.blog.personalblog.mapper;import com.blog.personalblog.entity.LoginOperationLog;import org.springframework.stereotype.Repository;import java.util.List;/** * * @author: SuperMan * @create: 2022-04-06 **/@Repositorypublic interface LoginOperationLogMapper {    /**     * 创建登录日志     * @param loginOperationLog     * @return     */    int createLoginOperationLog(LoginOperationLog loginOperationLog);    /**     * 分类列表（分页）     * @return     */    List<LoginOperationLog> getLoginOperationLogPage();}

5、xml文件

新建一个登录日志的LoginOperationLogMapper.xml文件，用来写sql语句。

<?xml version="1.0" encoding="UTF-8" ?><!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="com.blog.personalblog.mapper.LoginOperationLogMapper">    <resultMap id="BaseResultMap" type="com.blog.personalblog.entity.LoginOperationLog"> <result column="id" jdbcType="INTEGER" property="id"/> <result column="login_name" jdbcType="VARCHAR" property="loginName"/> <result column="ip_address" jdbcType="VARCHAR" property="ipAddress"/> <result column="login_location" jdbcType="VARCHAR" property="loginLocation"/> <result column="browser_type" jdbcType="VARCHAR" property="browserType"/> <result column="os" jdbcType="VARCHAR" property="os"/> <result column="login_status" jdbcType="INTEGER" property="loginStatus"/> <result column="create_time" jdbcType="TIMESTAMP" property="createTime"/>    </resultMap>    <insert id="createLoginOperationLog" parameterType="com.blog.personalblog.entity.LoginOperationLog" useGeneratedKeys="true" keyProperty="id"> INSERT INTO person_login_log (login_name, ip_address, login_location, browser_type, os, login_status) VALUES(#{loginName}, #{ipAddress}, #{loginLocation}, #{browserType}, #{os}, #{loginStatus})    </insert>    <select id="getLoginOperationLogPage" resultMap="BaseResultMap"> select * from person_login_log    </select></mapper>

6、接口层

新建一个日志的接口，我看了一下上边的操作日志我也没写接口层，所以我们将操作日志和登录日志写在一个Controller层中了。
先建一个OperationLogController.java

package com.blog.personalblog.controller;import com.blog.personalblog.config.page.PageRequest;import com.blog.personalblog.config.page.PageResult;import com.blog.personalblog.entity.LoginOperationLog;import com.blog.personalblog.entity.OperationLog;import com.blog.personalblog.service.LoginOperationLogService;import com.blog.personalblog.service.OperationLogService;import com.blog.personalblog.util.JsonResult;import com.blog.personalblog.util.PageUtil;import com.github.pagehelper.PageInfo;import io.swagger.annotations.Api;import io.swagger.annotations.ApiOperation;import org.springframework.web.bind.annotation.PostMapping;import org.springframework.web.bind.annotation.RequestBody;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;import javax.annotation.Resource;import javax.validation.Valid;import java.util.List;/** * * @author: SuperMan * @create: 2022-04-06 **/@Api(tags = "操作日志")@RestController@RequestMapping("/log")public class OperationLogController {    @Resource    private LoginOperationLogService loginOperationLogService;    @Resource    private OperationLogService operationLogService;    /**     * 操作日志列表     * @param pageRequest     * @return     */    @ApiOperation(value = "操作日志列表")    @PostMapping("list")    public JsonResult<Object> OperationLogListPage(@RequestBody @Valid PageRequest pageRequest) { List<OperationLog> operationLogPage = operationLogService.getOperationLogPage(pageRequest); PageInfo pageInfo = new PageInfo(operationLogPage); PageResult pageResult = PageUtil.getPageResult(pageRequest, pageInfo); return JsonResult.success(pageResult);    }    /**     * 登录日志列表     * @param pageRequest     * @return     */    @ApiOperation(value = "登录日志列表")    @PostMapping("list")    public JsonResult<Object> LoginOperationLogListPage(@RequestBody @Valid PageRequest pageRequest) { List<LoginOperationLog> loginOperationLogPage = loginOperationLogService.getLoginOperationLogPage(pageRequest); PageInfo pageInfo = new PageInfo(loginOperationLogPage); PageResult pageResult = PageUtil.getPageResult(pageRequest, pageInfo); return JsonResult.success(pageResult);    }}

好啦，准备工作基本上完成了，接下来我们再登录的时候插入我们的登录日志即可。

7、登录日志编写

打开我们的UserController.java类，然后找到我们的登录方法，我们再UserController中新添加一个方法，用来获取登录信息并且将登录的信息插入到登录日志表中。
我们设计的表里有要获取浏览器类型和操作系统，所以我们使用了user-agent-utils 是一个用来解析 User-Agent 字符串的 Java 类库。 其能够识别的内容包括： 超过150种不同的浏览器； 7种不同的浏览器类型； 超过60种不同的操作系统； 6种不同的设备类型； 9种不同的渲染引擎； 9种不同的Web应用，如HttpClient、Bot。

1、添加maven

<dependency>    <groupId>eu.bitwalker</groupId>    <artifactId>UserAgentUtils</artifactId>    <version>1.21</version> </dependency>

2、客户端工具类

package com.blog.personalblog.util;import cn.hutool.core.convert.Convert;import org.springframework.web.context.request.RequestAttributes;import org.springframework.web.context.request.RequestContextHolder;import org.springframework.web.context.request.ServletRequestAttributes;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import javax.servlet.http.HttpSession;/** * 客户端工具类 * */public class ServletUtils {    /**     * 获取String参数     */    public static String getParameter(String name)    { return getRequest().getParameter(name);    }    /**     * 获取String参数     */    public static String getParameter(String name, String defaultValue)    { return Convert.toStr(getRequest().getParameter(name), defaultValue);    }    /**     * 获取Integer参数     */    public static Integer getParameterToInt(String name)    { return Convert.toInt(getRequest().getParameter(name));    }    /**     * 获取Integer参数     */    public static Integer getParameterToInt(String name, Integer defaultValue)    { return Convert.toInt(getRequest().getParameter(name), defaultValue);    }    /**     * 获取request     */    public static HttpServletRequest getRequest()    { return getRequestAttributes().getRequest();    }    /**     * 获取response     */    public static HttpServletResponse getResponse()    { return getRequestAttributes().getResponse();    }    /**     * 获取session     */    public static HttpSession getSession()    { return getRequest().getSession();    }    public static ServletRequestAttributes getRequestAttributes()    { RequestAttributes attributes = RequestContextHolder.getRequestAttributes(); return (ServletRequestAttributes) attributes;    }}

下面进行解析agent字符串

UserAgent userAgent = UserAgent.parseUserAgentString(ServletUtils.getRequest().getHeader("User-Agent"));

其他的也没有什么，下面就是我们添加登录日志的方法

    /**     * 获取登录日志     */    public void getLoginInfoLog(LoginModel loginModel, Integer status) { RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes(); HttpServletRequest request = (HttpServletRequest) Objects.requireNonNull(requestAttributes).resolveReference(RequestAttributes.REFERENCE_REQUEST); //解析agent字符串 UserAgent userAgent = UserAgent.parseUserAgentString(ServletUtils.getRequest().getHeader("User-Agent")); //登录账号 LoginOperationLog loginOperationLog = new LoginOperationLog(); loginOperationLog.setLoginName(loginModel.getUsername()); //登录IP地址 String ipAddr = IpUtil.getIpAddr(request); loginOperationLog.setIpAddress(ipAddr); //登录地点 String ipInfo = IpUtil.getIpInfo(ipAddr); loginOperationLog.setLoginLocation(ipInfo); //浏览器类型 String browser = userAgent.getBrowser().getName(); loginOperationLog.setBrowserType(browser); //操作系统 String os = userAgent.getOperatingSystem().getName(); loginOperationLog.setOs(os); //登录状态 loginOperationLog.setLoginStatus(status); loginOperationLogService.saveOperationLog(loginOperationLog);    }

然后我们在登录的方法中添加这个方法，一共传了两个参数，其中status是登录的状态，成功是0，失败是1。

    /**     * 登录     * @param loginModel     * @return     */    @ApiOperation(value = "登录")    @PostMapping("/login")    @OperationLogSys(desc = "登录", operationType = OperationType.LOGIN)    public JsonResult<Object> login(@RequestBody LoginModel loginModel){ logger.info("{} 在请求登录！ ", loginModel.getUsername()); Subject subject = SecurityUtils.getSubject(); UsernamePasswordToken token = new UsernamePasswordToken(loginModel.getUsername(), loginModel.getPassword(), false); try {     subject.login(token);     Map<String, Object> ret = new HashedMap();     ret.put("token", subject.getSession().getId());     logger.info("{} login success", loginModel.getUsername());     getLoginInfoLog(loginModel, 0);     return JsonResult.success(ret); } catch (IncorrectCredentialsException e) {     logger.info("login fail {}", e.getMessage());     return JsonResult.error(ErrorCode.NOT_LOGIN); } catch (LockedAccountException e) {     logger.info("login fail {}", e.getMessage());     return JsonResult.error(ErrorCode.ERROR_CODE); } catch (AuthenticationException e) {     logger.info("login fail {}", e.getMessage());     return JsonResult.error(ErrorCode.USER_NOT_EXIST); } catch (Exception e) {     e.printStackTrace();     getLoginInfoLog(loginModel, 1);     logger.info("login fail {}", e.getMessage());     return JsonResult.error(ErrorCode.ERROR_CODE); }    }

下面是UserController的完整代码：（有些地方改了一点，大家可以看一下）

package com.blog.personalblog.controller;import cn.hutool.core.util.StrUtil;import com.blog.personalblog.annotation.OperationLogSys;import com.blog.personalblog.annotation.OperationType;import com.blog.personalblog.entity.ErrorCode;import com.blog.personalblog.entity.LoginModel;import com.blog.personalblog.entity.LoginOperationLog;import com.blog.personalblog.service.LoginOperationLogService;import com.blog.personalblog.util.IpUtil;import com.blog.personalblog.util.JsonResult;import com.blog.personalblog.entity.User;import com.blog.personalblog.service.UserService;import com.blog.personalblog.util.MD5Util;import com.blog.personalblog.util.PhoneUtil;import com.blog.personalblog.util.ServletUtils;import eu.bitwalker.useragentutils.UserAgent;import io.swagger.annotations.Api;import io.swagger.annotations.ApiOperation;import org.apache.commons.collections.map.HashedMap;import org.apache.shiro.SecurityUtils;import org.apache.shiro.authc.AuthenticationException;import org.apache.shiro.authc.IncorrectCredentialsException;import org.apache.shiro.authc.LockedAccountException;import org.apache.shiro.authc.UsernamePasswordToken;import org.apache.shiro.subject.Subject;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.web.bind.annotation.*;import org.springframework.web.context.request.RequestAttributes;import org.springframework.web.context.request.RequestContextHolder;import javax.annotation.Resource;import javax.servlet.http.HttpServletRequest;import javax.validation.Valid;import java.util.HashMap;import java.util.List;import java.util.Map;import java.util.Objects;/** * @author: SuperMan * 欢迎关注我的公众号：码上言 * @create: 2021-11-03 */@Api(tags = "用户管理")@RestController@RequestMapping("/user")public class UserController {    private Logger logger = LoggerFactory.getLogger(this.getClass());    @Resource    private UserService userService;    @Resource    private LoginOperationLogService loginOperationLogService;    /**     * 用户列表     * @return     */    @ApiOperation(value = "用户列表")    @PostMapping("/list")    public JsonResult<Object> list() { List<User> userList = userService.findAll(); return JsonResult.success(userList);    }    /**     * 添加用户     * @return     */    @ApiOperation(value = "添加用户")    @PostMapping("/create")    @OperationLogSys(desc = "添加用户", operationType = OperationType.INSERT)    public JsonResult<Object> userCreate(@RequestBody @Valid User user) { if (StrUtil.isEmpty(user.getPassWord())) {     return JsonResult.error("密码为空，请填写密码！"); } //密码加密存储 user.setPassWord(MD5Util.MD5(user.getPassWord())); //判断手机号，这里用hutool工具类也可以 if (!PhoneUtil.checkMobile(user.getPhone())) {     return JsonResult.error("手机号码格式错误！"); } userService.createUser(user); return JsonResult.success();    }    /**     *     * 修改用户     * @return     */    @ApiOperation(value = "修改用户")    @PostMapping("/update")    @OperationLogSys(desc = "修改用户", operationType = OperationType.UPDATE)    public JsonResult<Object> userUpdate(@RequestBody @Valid User user) { if (StrUtil.isEmpty(user.getPassWord())) {     return JsonResult.error("密码为空，请填写密码！"); } //密码加密存储 user.setPassWord(MD5Util.MD5(user.getPassWord())); //判断手机号，这里用hutool工具类也可以 if (!PhoneUtil.checkMobile(user.getPhone())) {     return JsonResult.error("手机号码格式错误！"); } userService.updateUser(user); return JsonResult.success();    }    /**     * 删除     * @return     */    @ApiOperation(value = "删除用户")    @PostMapping("/delete/{id}")    @OperationLogSys(desc = "删除用户", operationType = OperationType.DELETE)    public JsonResult<Object> userDelete(@PathVariable(value = "id") int id) { userService.deleteUser(id); return JsonResult.success();    }    /**     * 登录     * @param loginModel     * @return     */    @ApiOperation(value = "登录")    @PostMapping("/login")    @OperationLogSys(desc = "登录", operationType = OperationType.LOGIN)    public JsonResult<Object> login(@RequestBody LoginModel loginModel){ logger.info("{} 在请求登录！ ", loginModel.getUsername()); Subject subject = SecurityUtils.getSubject(); UsernamePasswordToken token = new UsernamePasswordToken(loginModel.getUsername(), loginModel.getPassword(), false); try {     subject.login(token);     Map<String, Object> ret = new HashedMap();     ret.put("token", subject.getSession().getId());     logger.info("{} login success", loginModel.getUsername());     getLoginInfoLog(loginModel, 0);     return JsonResult.success(ret); } catch (IncorrectCredentialsException e) {     logger.info("login fail {}", e.getMessage());     return JsonResult.error(ErrorCode.NOT_LOGIN); } catch (LockedAccountException e) {     logger.info("login fail {}", e.getMessage());     return JsonResult.error(ErrorCode.ERROR_CODE); } catch (AuthenticationException e) {     logger.info("login fail {}", e.getMessage());     return JsonResult.error(ErrorCode.USER_NOT_EXIST); } catch (Exception e) {     e.printStackTrace();     getLoginInfoLog(loginModel, 1);     logger.info("login fail {}", e.getMessage());     return JsonResult.error(ErrorCode.ERROR_CODE); }    }    /**     * 登录info信息     * @return     */    @GetMapping("/info")    public JsonResult<Object> info(){ Map<String, Object> ret = new HashMap<>(3); ret.put("roles", "[admin]"); ret.put("name", "admin"); ret.put("avatar","https://wpimg.wallstcn.com/f778738c-e4f8-4870-b634-56703b4acafe.gif"); return JsonResult.success(ret);    }    /**     * 获取登录日志     */    public void getLoginInfoLog(LoginModel loginModel, Integer status) { RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes(); HttpServletRequest request = (HttpServletRequest) Objects.requireNonNull(requestAttributes).resolveReference(RequestAttributes.REFERENCE_REQUEST); //解析agent字符串 UserAgent userAgent = UserAgent.parseUserAgentString(ServletUtils.getRequest().getHeader("User-Agent")); //登录账号 LoginOperationLog loginOperationLog = new LoginOperationLog(); loginOperationLog.setLoginName(loginModel.getUsername()); //登录IP地址 String ipAddr = IpUtil.getIpAddr(request); loginOperationLog.setIpAddress(ipAddr); //登录地点 String ipInfo = IpUtil.getIpInfo(ipAddr); loginOperationLog.setLoginLocation(ipInfo); //浏览器类型 String browser = userAgent.getBrowser().getName(); loginOperationLog.setBrowserType(browser); //操作系统 String os = userAgent.getOperatingSystem().getName(); loginOperationLog.setOs(os); //登录状态 loginOperationLog.setLoginStatus(status); loginOperationLogService.saveOperationLog(loginOperationLog);    }}

8、测试

我们在postman中模拟登录，然后我们在sql中查看有没有登录日志，这里要说一下，如果你是用的地址为localhost或者127.0.0.1进行请求，我们在获取ip归属地的时候会获取不到，我们可以使用电脑的ip就可以看到。

好啦，到这里我们的操作日志就完成了，到此我们所有的后端功能都开发完了，下面我们就写前端代码，后端提供api即可，我们的项目开发2/3了，即将完成了，大家努力啊。
看到现在的阅读量，着实有点惨不忍睹，希望大家多多点赞、收藏、分享啊，大家帮我宣传一下，感谢感谢！

上一篇：Spring Boot + vue-element 开发个人博客项目实战教程（十七、登录功能实现（下））
下一篇：Spring Boot + vue-element 开发个人博客项目实战教程（十九、待定）