后台系统实现登录登出以及过滤器功能
后台系统登录功能-代码开发（创建controller，service，mapper，实体类以及过滤器）
登录
一. 登录需求分析
页面原型
- 登录页面展示：项目路径（\resources\backend\page\login\login.html）
我们要实现的是：员工点击登录按钮进行后管平台的登录操作，登录正确以外方式不可登录。
登录处理逻辑
1、将页面提交的密码进行MD5加密
2、根据用户名查数据库(查不到返回结果)
3、比对密码(密码错误返回结果)
4、查询员工状态，员工状态禁用下不可登录
5、登录成功，写入session中，返回结果。
二. 配置返回通用结果类
package com.yuanye.common;
import lombok.Data;
import java.util.HashMap;
import java.util.Map;
/**
* 通用返回结果类，服务端响应的数据最终都会封装成此对象
* @param <T>
*/
@Data
//为了增强通用性，R对象设计了泛型
public class R<T> {
private Integer code; //编码：1成功，0和其它数字为失败
private String msg; //错误信息
//主体的数据最终就会传进来，比如登录的时候data赋的值就是一个employee员工对象
// 后面在开发的时候可能还有其他对象，所以用到了泛型，增强通用性
private T data; //数据
private Map map = new HashMap(); //动态数据
//响应成功的时候就会调用R.success
public static <T> R<T> success(T object) {
R<T> r = new R<T>();
r.data = object;
r.code = 1;
return r;
}
//登录失败的时候就会调用R.error
public static <T> R<T> error(String msg) {
R r = new R();
r.msg = msg;
r.code = 0;
return r;
}
public R<T> add(String key, Object value) {
this.map.put(key, value);
return this;
}
}
三. 登录请求API
四. 创建实体类并实现登录逻辑
entity: 创建实体类
package com.yuanye.entity;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import lombok.Data;
import java.io.Serializable;
import java.time.LocalDateTime;
/**
* 员工实体
*/
@Data
public class Employee implements Serializable {
/** 序列号*/
private static final long serialVersionUID = 1L;
/**唯一主键*/
private Long id;
/**用户名*/
private String username;
/**姓名*/
private String name;
/**密码*/
private String password;
/**电话*/
private String phone;
/**性别*/
private String sex;
/**身份证号码*/
private String idNumber;
/**状态*/
private Integer status;
/**创建时间*/
private LocalDateTime createTime;
/**更新时间*/
private LocalDateTime updateTime;
/**添加用户时使用*/
@TableField(fill = FieldFill.INSERT)
private Long createUser;
/**更新用户时使用*/
@TableField(fill = FieldFill.INSERT_UPDATE)
private Long updateUser;
}
mapper数据库交互层
package com.yuanye.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.yuanye.entity.Employee;
import org.apache.ibatis.annotations.Mapper;
//泛型指定实体类
@Mapper
public interface EmployeeMapper extends BaseMapper<Employee> {
}
service业务层接口
package com.yuanye.service.impl;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.yuanye.entity.Employee;
import com.yuanye.mapper.EmployeeMapper;
import com.yuanye.service.EmployeeService;
import org.springframework.stereotype.Service;
//指定两个泛型 第一个是mapper 第二个是实体 然后实现service接口
@Service
public class EmployeeServiceImpl extends ServiceImpl<EmployeeMapper, Employee> implements EmployeeService {
}
业务层实现类
package com.yuanye.service.impl;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.yuanye.entity.Employee;
import com.yuanye.mapper.EmployeeMapper;
import com.yuanye.service.EmployeeService;
import org.springframework.stereotype.Service;
//指定两个泛型 第一个是mapper 第二个是实体 然后实现service接口
@Service
public class EmployeeServiceImpl extends ServiceImpl<EmployeeMapper, Employee> implements EmployeeService {
}
controller控制层
package com.yuanye.controller;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.yuanye.common.R;
import com.yuanye.entity.Employee;
import com.yuanye.service.EmployeeService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.DigestUtils;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
@Slf4j
@RestController
@RequestMapping("/employee")
public class EmployeeController {
//注入service接口
@Resource
private EmployeeService employeeService;
/**
* 员工登录
* @param request
* @param employee
* @return
*/
//postmapping是因为前端发送的请求是post
//前端登录的时候发送的参数是json形式，接受的时候需要加个注解@ResponseBody,在这封装成employee对象
//还需要在加个HttpServletRequest,因为如果登录成功之后需要把employee对象的id存到session一份表示登录成功
//这样如果想获取当前登录用户的话就随时可以通过request对象获取出来，来get一个session
@PostMapping("/login")
public R<Employee> login(HttpServletRequest request,@RequestBody Employee employee){
//1、将页面提交的密码password进行md5加密
String password = employee.getPassword();
//调用DigestUtils工具类进行加密，转成Bytes数组 赋值回自己
password = DigestUtils.md5DigestAsHex(password.getBytes());
//2、根据页面提交的用户名username查询数据库
//LambdaQueryWrapper包装查询对象
LambdaQueryWrapper<Employee> queryWrapper = new LambdaQueryWrapper<>();
//添加查询条件 等值查询，根据用户名
queryWrapper.eq(Employee::getUsername,employee.getUsername());
//调用service的getone方法，因为数据库里面已经对username字段做了唯一的约束，就能查询唯一的数据,从数据库里面查出对象emp
Employee emp = employeeService.getOne(queryWrapper);
//3、如果没有查询到则返回登录失败结果，就不继续往下走了 直接return
if (emp == null){
return R.error("登录失败");
}
//4、密码比对，如果不一致则返回登录失败结果
if (!emp.getPassword().equals(password)){
return R.error("登录失败");
}
//5、查看员工状态，如果为已禁用状态，则返回员工已禁用结果
if (emp.getStatus() == 0){
return R.error("账号已禁用");
}
//6、登录成功，将员工id存入Session并返回登录成功结果
request.getSession().setAttribute("employee",emp.getId());
return R.success(emp);
}
/**
* 员工退出
* @param request
* @return
*/
//退出不需要返回详细的数据，泛型就给个字符串
@PostMapping("/logout")
//退出就是将session中的用户id清理掉，需要操作session，参数要加上HttpServletRequest request
public R<String> logout(HttpServletRequest request){
//清理session中保存的当前员工id
request.getSession().removeAttribute("employee");
return R.success("退出成功");
}
}
五. 功能测试
Debug测试时主要测试以下几点：
1.用户名与密码的校验
2.用户状态禁用情况下
3.数据是否正确返回
附录
常量类：
package com.itheima.reggie.common;
public class CommonsConst {
// 登录失败
public static final String LOGIN_FAIL = "登录失败";
// 账号禁用
public static final String LOGIN_ACCOUNT_STOP = "账号禁止使用";
// 员工账号禁用状态 0：禁用
public static final Integer EMPLOYEE_STATUS_NO = 0;
// 员工账号正常状态 1：正常使用
public static final Integer EMPLOYEE_STATUS_YES = 1;
}
退出登录
一、需求分析
员工登录之后，页面跳转到后台首页（backend/index.html）此前会显示用户登录的用户名，点击退出按钮退出系统。
请求地址URL employee/loginout
请求参数 无
返回参数 ({
"code": 1,
"msg": null,
"data": "退出成功",
"map": {}
}
二. 功能实现
只需要清除session即可，在controller中添加如下代码：
/**
* 后管登出
* @param request
* @return
*/
@PostMapping("/logout")
public R<String> loginOut(HttpServletRequest request){
// 去除session
request.getSession().removeAttribute("employee");
return R.success("退出成功");
}
三. 功能测试
登录成功后是有session记录的：
点击页码按钮退出后session清除，并返回登录页面就表示成功了。
四. 登录功能完善，增加过滤器
4.1 问题分析
前面已经完成了登录功能的开发，但会发现一个问题，就是员工不登录情况下，依然能够进入到目标页面很显然这并不是我们想看到的。
那如何实现呢?使用过滤器或者拦截器，在过滤器或者拦截器中判断用户是否是登录状态，没有登录则跳转到登录页面。
4.2 实现步骤
创建自定义过滤器LoginCheckFilter.java
启动类上加入@ServletComponentScan（这个不要忘记了）
完善过滤器处理逻辑
过滤器处理逻辑主要如下：
1、获取本次处理请求的URL
2、判断本次请求是否需要处理
3、若不需要，直接放行
4、判断登陆状态，若已经登陆直接放行
5、若未登陆则返回未登陆结果
流程图如下：
4.3 代码实现
判断用户的登陆状态这块之前因为存入session里面有一个名为employee的对象，那么只需要看看这个session还在不在就知道他是否在登陆状态
注意，想存或者想获取的话，就都得用HttpServletRequest的对象来进行获取，别的request对象拿不到的
这里提一嘴
调用Spring核心包的字符串匹配类的对象，对路径进行匹配，并且返回比较结果
如果相等就为true
public static final AntPathMatcher PATH_MATCHER = new AntPathMatcher();
package com.yuanye.filter;
import com.alibaba.fastjson.JSON;
import com.yuanye.common.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.AntPathMatcher;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
* 检查用户是否已经完成登录
*/
//filterName过滤器名称 urlPatterns拦截哪些路径 /* 所有请求都拦截
@WebFilter(filterName = "loginCheckFilter",urlPatterns = "/*")
@Slf4j
public class LoginCheckFilter implements Filter {
//路径匹配器，支持通配符，专门用于进行路径比较的
public static final AntPathMatcher PATH_MATCHER = new AntPathMatcher();
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) servletRequest;
HttpServletResponse response = (HttpServletResponse) servletResponse;
//1、获取本次请求的uri
String requestURI = request.getRequestURI();
log.info("拦截到请求:{}",requestURI);
//定义一些哪些请求路径不需要处理
String[] urls = new String[]{
"/employee/login",
"/employee/logout",
"/backend/**",
"/front/**"
};
//2、判断本次请求是否需要处理
boolean check = check(urls, requestURI);
//3、如果不需要处理，则直接放行
if (check){
log.info("本次请求{}不需要处理",requestURI);
//放行
filterChain.doFilter(request,servletResponse);
return;
}
//4、判断登录状态，如果已登录，则直接放行
if(request.getSession().getAttribute("employee") != null){
log.info("用户已登录，用户id为{}",request.getSession().getAttribute("employee"));
//放行
filterChain.doFilter(request,servletResponse);
return;
}
log.info("用户未登录");
//5、如果未登录则返回未登录结果,通过输出流方式向客户端页面响应数据
response.getWriter().write(JSON.toJSONString((R.error("NOTLOGIN"))));
return;
}
/**
* 路径匹配，检查本次请求是否需要放行
* @param urls
* @param requestURI
* @return
*/
public boolean check(String[] urls,String requestURI){
for (String url : urls) {
//调用路径匹配器
boolean match = PATH_MATCHER.match(url, requestURI);
if (match){
return true;
}
}
return false;
}
}
浙公网安备 33010602011771号