开发登录 退出功能

开发登录 退出功能

访问登录页面

点击顶部区域内的链接，打开登录页面

登录

验证账号，密码，验证码。

成功时，生成登录凭证，发给客户端。

失败时，跳转返回登录页面。

退出

将登录凭证修改为失效状态。

跳转至网站首页。

新建LoginTicket 实体类

新建LoginTicketMapper接口

@Mapper
public interface LoginTicketMapper {
​
    @Insert({
            "insert into login_ticket(user_id,ticket,status,expired) ",
            "values(#{userId},#{ticket},#{status},#{expired})"
    })
    //声明SQL
    @Options(useGeneratedKeys = true, keyProperty = "id")
    int insertLoginTicket(LoginTicket loginTicket);
​
    @Select({
            "select id,user_id,ticket,status,expired ",
            "from login_ticket where ticket=#{ticket}"
    })
    LoginTicket selectByTicket(String ticket);
​
    @Update({
            //生成动态SQL
            "<script>",
            "update login_ticket set status=#{status} where ticket=#{ticket} ",
            "<if test=\"ticket!=null\"> ",
            "and 1=1 ",
            "</if>",
            "</script>"
    })
    int updateStatus(String ticket, int status);
​
}

Login Controller

//处理表单提交过来的数据用post
@RequestMapping(path = "/login", method = RequestMethod.POST)
public String login(String username, String password, String code, boolean rememberme,//记住我
                    Model model, HttpSession session, HttpServletResponse response) {
    // 检查验证码
    String kaptcha = (String) session.getAttribute("kaptcha");
    if (StringUtils.isBlank(kaptcha) || StringUtils.isBlank(code) || !kaptcha.equalsIgnoreCase(code)) {
        model.addAttribute("codeMsg", "验证码不正确!");
        return "/site/login";
    }
​
    // 检查账号,密码
    int expiredSeconds = rememberme ? REMEMBER_EXPIRED_SECONDS : DEFAULT_EXPIRED_SECONDS;
    Map<String, Object> map = userService.login(username, password, expiredSeconds);
    if (map.containsKey("ticket")) {
        Cookie cookie = new Cookie("ticket", map.get("ticket").toString());
        cookie.setPath(contextPath);
        cookie.setMaxAge(expiredSeconds);
        response.addCookie(cookie);
        //重定向到首页
        return "redirect:/index";
    } else {
        model.addAttribute("usernameMsg", map.get("usernameMsg"));
        model.addAttribute("passwordMsg", map.get("passwordMsg"));
        //返回到登录页面
        return "/site/login";
    }
}
​
//退出登录
@RequestMapping(path = "/logout", method = RequestMethod.GET)
public String logout(@CookieValue("ticket") String ticket) {
    userService.logout(ticket);
    return "redirect:/login";
}

UserService

//登录
public Map<String, Object> login(String username, String password, int expiredSeconds) {
    Map<String, Object> map = new HashMap<>();
​
    // 空值处理
    if (StringUtils.isBlank(username)) {
        map.put("usernameMsg", "账号不能为空!");
        return map;
    }
    if (StringUtils.isBlank(password)) {
        map.put("passwordMsg", "密码不能为空!");
        return map;
    }
​
    // 验证账号
    User user = userMapper.selectByName(username);
    if (user == null) {
        map.put("usernameMsg", "该账号不存在!");
        return map;
    }
​
    // 验证状态
    if (user.getStatus() == 0) {
        map.put("usernameMsg", "该账号未激活!");
        return map;
    }
​
    // 验证密码
    password = CommunityUtil.md5(password + user.getSalt());
    if (!user.getPassword().equals(password)) {
        map.put("passwordMsg", "密码不正确!");
        return map;
    }
​
    // 生成登录凭证
    LoginTicket loginTicket = new LoginTicket();
    loginTicket.setUserId(user.getId());
    loginTicket.setTicket(CommunityUtil.generateUUID());
    loginTicket.setStatus(0);
    //过期时间
    loginTicket.setExpired(new Date(System.currentTimeMillis() + expiredSeconds * 1000));
    loginTicketMapper.insertLoginTicket(loginTicket);
​
    map.put("ticket", loginTicket.getTicket());
    return map;
}
​
//登录退出
public void logout(String ticket) {
    loginTicketMapper.updateStatus(ticket, 1);
}

测试结果：

显示登录信息

拦截器示例

低耦合度解决问题

定义拦截器，实现HandlerInterceptor（接口）

配置拦截器，为它指定拦截，排除的路径

拦截器应用

在请求开始时查询登录用户

在本次请求中持有用户数据

在模板视图上显示用户数据

在请求结束时清理用户数据

新建Interceptor包 新建AlphaInterceptor（拦截器）类

@Component
public class AlphaInterceptor implements HandlerInterceptor {
​
    private static final Logger logger = LoggerFactory.getLogger(AlphaInterceptor.class);
    // 在Controller之前执行
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        logger.debug("preHandle: " + handler.toString());
        return true;
    }
​
    // 在Controller之后执行
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        logger.debug("postHandle: " + handler.toString());
    }
​
    // 在TemplateEngine之后执行
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        logger.debug("afterCompletion: " + handler.toString());
    }
}

新建LoginTicketInterceptor类

//拦截器
@Component
public class LoginTicketInterceptor implements HandlerInterceptor {
​
    @Autowired
    private UserService userService;
​
    @Autowired
    private HostHolder hostHolder;
​
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 从cookie中获取凭证
        String ticket = CookieUtil.getValue(request, "ticket");
​
        if (ticket != null) {
            // 查询凭证
            LoginTicket loginTicket = userService.findLoginTicket(ticket);
            // 检查凭证是否有效（凭证结果不为空且结果是0，并且超时时间晚于当前时间 ）
            if (loginTicket != null && loginTicket.getStatus() == 0 && loginTicket.getExpired().after(new Date())) {
                // 根据凭证查询用户
                User user = userService.findUserById(loginTicket.getUserId());
                // 在本次请求中持有用户（考虑多线程情况  ）
                hostHolder.setUser(user);
            }
        }
​
        return true;
    }
​
    //在模板引擎之前使用，把user存到model里
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        User user = hostHolder.getUser();
        if (user != null && modelAndView != null) {
            modelAndView.addObject("loginUser", user);
        }
    }
​
    //模板执行完，清理数据
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        hostHolder.clear();
    }
}

新建WebMvcConfig配置拦截器类

//配置拦截器
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
​
    @Autowired
    private AlphaInterceptor alphaInterceptor;
​
    @Autowired
    private LoginTicketInterceptor loginTicketInterceptor;
​
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(alphaInterceptor)
                .excludePathPatterns("/**/*.css", "/**/*.js", "/**/*.png", "/**/*.jpg", "/**/*.jpeg")
                .addPathPatterns("/register", "/login");
​
        registry.addInterceptor(loginTicketInterceptor)
                .excludePathPatterns("/**/*.css", "/**/*.js", "/**/*.png", "/**/*.jpg", "/**/*.jpeg");
    }
​
}

新建CookieUtil

public class CookieUtil {
​
    public static String getValue(HttpServletRequest request, String name) {
        if (request == null || name == null) {
            throw new IllegalArgumentException("参数为空!");
        }
​
        Cookie[] cookies = request.getCookies();
        if (cookies != null) {
            for (Cookie cookie : cookies) {
                if (cookie.getName().equals(name)) {
                    return cookie.getValue();
                }
            }
        }
​
        return null;
    }

新建HostHolder

/**
 * 持有用户信息,用于代替session对象.
 */
@Component//起到容器的作用
public class HostHolder {
​
    //初始化ThreadLocal
    private ThreadLocal<User> users = new ThreadLocal<>();
​
    //外界调用
    public void setUser(User user) {
        users.set(user);
    }
​
    public User getUser() {
        return users.get();
    }
     //请求结束 清理
    public void clear() {
        users.remove();
    }
​
}

测试结果

 

账号设置

上传文件

请求：必须是Post请求

表单：enctype= "multipart/form-data"

spring MVC :通过Multi part File处理上传文件

开发步骤

访问账号设置页面

上传头像

获取头像

新建UserController

@Controller
@RequestMapping("/user")
public class UserController {
​
    private static final Logger logger = LoggerFactory.getLogger(UserController.class);
     @RequestMapping(path = "/setting", method = RequestMethod.GET)
    public String getSettingPage() {
        return "/site/setting";
    }

在index.html修改

<a class="dropdown-item text-center" th:href="@{/user/setting}">账号设置</a>

上传头像

获取头像

新建UserController

//账号设置
@Controller
@RequestMapping("/user")
public class UserController {
    //日志
    private static final Logger logger = LoggerFactory.getLogger(UserController.class);
​
    @Value("${community.path.upload}")
    private String uploadPath;
    //域名
    @Value("${community.path.domain}")
    private String domain;
    //项目路径
    @Value("${server.servlet.context-path}")
    private String contextPath;
​
    @Autowired
    private UserService userService;
​
    //更新当前头像
    @Autowired
    private HostHolder hostHolder;
​
    @RequestMapping(path = "/setting", method = RequestMethod.GET)
    public String getSettingPage() {
        return "/site/setting";
    }
​
    //处理上传，先进性判断
    @RequestMapping(path = "/upload", method = RequestMethod.POST)
    public String uploadHeader(MultipartFile headerImage, Model model) {
        if (headerImage == null) {
            model.addAttribute("error", "您还没有选择图片!");
            return "/site/setting";
        }
        //上传文件（用户存储命名相同，避免覆盖，会给每个名字重新编号） getOriginalFilename 原始文件名
        String fileName = headerImage.getOriginalFilename();
        String suffix = fileName.substring(fileName.lastIndexOf("."));
        if (StringUtils.isBlank(suffix)) {
            model.addAttribute("error", "文件的格式不正确!");
            return "/site/setting";
        }
​
        // 生成随机文件名
        fileName = CommunityUtil.generateUUID() + suffix;
        // 确定文件存放的路径
        File dest = new File(uploadPath + "/" + fileName);
        try {
            // 存储文件
            headerImage.transferTo(dest);
        } catch (IOException e) {
            logger.error("上传文件失败: " + e.getMessage());
            throw new RuntimeException("上传文件失败,服务器发生异常!", e);
        }
​
        // 更新当前用户的头像的路径(web访问路径)
        // http://localhost:8080/community/user/header/xxx.png
        User user = hostHolder.getUser();
        String headerUrl = domain + contextPath + "/user/header/" + fileName;
        userService.updateHeader(user.getId(), headerUrl);
​
        return "redirect:/index";
    }
     //外界获取头像服务
    @RequestMapping(path = "/header/{fileName}", method = RequestMethod.GET)
    public void getHeader(@PathVariable("fileName") String fileName, HttpServletResponse response) {
        // 服务器存放路径
        fileName = uploadPath + "/" + fileName;
        // 文件后缀
        String suffix = fileName.substring(fileName.lastIndexOf("."));
        // 响应图片
        response.setContentType("image/" + suffix);
        try (
                FileInputStream fis = new FileInputStream(fileName);
                OutputStream os = response.getOutputStream();
        ) {
            byte[] buffer = new byte[1024];
            int b = 0;
            while ((b = fis.read(buffer)) != -1) {
                os.write(buffer, 0, b);
            }
        } catch (IOException e) {
            logger.error("读取头像失败: " + e.getMessage());
        }
    }

#上传资源存放位置
community.path.upload=C:/Users/zt/AppData/Local/Temp/tomcat.2183951602158681383.8080/work/Tomcat/localhost/community

测试结果

 

检查登录状态

(当用户没有登录，无法通过路径访问系统功能，在服务端进行判断)

使用拦截器

在方法前标注自定义注解

拦截所有请求，只处理带有该注解的方法

自定义注解

常用的元注解：

@Target @Retention

如何读取注解：

Method.getDeclaredAnnotations()