SpringBoot实战项目（十七）--使用拦截器实现系统日志功能

系统日志一般用来记录用户登录系统后的一些操作记录

谁（当前登录用户）--- 什么时间---- 做了哪些操作

新建sys_log(日志记录表)

CREATE TABLE `sys_log` (
  `logId` int(11) NOT NULL AUTO_INCREMENT,
  `userName` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL,
  `msg` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL,
  `createTime` timestamp NOT NULL ON UPDATE CURRENT_TIMESTAMP,
  PRIMARY KEY (`logId`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=13 DEFAULT CHARSET=utf8;

实体类

@Data
@ToString
public class SysLog implements Serializable {

    private Long logId;
    private String userName;
    private String msg;
    private String createTime;

利用自定义拦截器---MyInterceptor实现业务逻辑及数据保存操作

package com.beilin.interceptor;



import com.beilin.dao.LogDao;
import com.beilin.entity.SysLog;
import com.beilin.entity.SysUser;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;


import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Date;

/**
 *  拦截器
 */
public class MyInterceptor implements HandlerInterceptor {

    @Autowired
    private LogDao logDao;

 

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        //获取当前用户
        SysUser user = (SysUser)request.getSession().getAttribute("user");
        Object msg = request.getSession().getAttribute("msg");
        //传操作的JAVABEAN过来
        if (user != null && msg != null) {
            //写入日志
            SysLog log = new SysLog();
            log.setUserName(user.getUserName());
            log.setMsg(msg.toString());
            logDao.save(log);
            //删除msg
            request.getSession().removeAttribute("msg");
        }
    }

}

（注意：拦截器原本需要重写三个方法的，这里为了方便直观，只保留所需的，完整的最后附上）

这里都有相关文字说明，不再一一赘述，只要了解了设计思想其实很容易

用户做新增，修改，删除操作的时候才需要做记录，查看之类的就没必要

 @PostMapping("/add")
    @ResponseBody
  　　//新增用户
    public Results<SysUser> save(SysUser sysUser, Integer roleId, HttpServletRequest request) {
       List<SysUser> results = userService.getUser(sysUser.getUserName(),sysUser.getTelephone(),sysUser.getEmail());
       if (results != null && results.size()>0){
           for (SysUser user : results){
               //判断用户名是否已存在
                if (user.getUserName().equals(sysUser.getUserName())){
                        return Results.failure(ResponseCode.USERNAME_REPEAT.getCode(), ResponseCode.USERNAME_REPEAT.getMessage());
                    }
                     //判断手机号是否已存在
                    if (user.getTelephone().equals(sysUser.getTelephone())) {
                        return Results.failure(ResponseCode.PHONE_REPEAT.getCode(), ResponseCode.PHONE_REPEAT.getMessage());
                    }
                    //判断邮箱是否已存在
                    if (user.getEmail().equals(sysUser.getEmail())) {
                        return Results.failure(ResponseCode.EMAIL_REPEAT.getCode(), ResponseCode.EMAIL_REPEAT.getMessage());
                    }
           }
       }
       sysUser.setStatus(1);
       //MD5加密
       sysUser.setPassWord(Md5Cipher.encryptWithSalt(sysUser.getPassWord()));
       request.getSession().setAttribute("msg","新增了用户资料："+sysUser.toString());
            return userService.save(sysUser,roleId);
    }

如代码所示，msg记录用户的操作内容，这里sysUser.toString()方法我只取几个有意义的值，有兴趣的可以自己重写或者拼接

 这样，sys_log表的字段都有值了，接下来把信息保存到数据库即可

 

 这里比较简单不需要写service层了

项目最终效果----

 

package com.beilin.interceptor;



import com.beilin.dao.LogDao;
import com.beilin.entity.SysLog;
import com.beilin.entity.SysUser;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;


import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Date;

/**
 *  拦截器
 */
public class MyInterceptor implements HandlerInterceptor {

    @Autowired
    private LogDao logDao;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //获取登录时保存到session的用户信息
        SysUser user = (SysUser) request.getSession().getAttribute("user");
        if (user == null) {
            //拦截未登录请求
            request.getRequestDispatcher("/login").forward(request, response);
            return false;
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        //获取当前用户
        SysUser user = (SysUser)request.getSession().getAttribute("user");
        Object msg = request.getSession().getAttribute("msg");
        //传操作的JAVABEAN过来
        if (user != null && msg != null) {
            //写入日志
            SysLog log = new SysLog();
            log.setUserName(user.getUserName());
            log.setMsg(msg.toString());
            logDao.save(log);
            //删除msg
            request.getSession().removeAttribute("msg");
        }
    }

}