2.6 显示登录信息

拦截器示例

• 定义一个拦截器，实现HandlerInterceptor
• 配置拦截器，为它指定拦截、排除的路径

拦截器应用

• 在请求开始时查询登录用户
• 在本次请求中持用用户数据
• 在模板视图上显示用户数据
• 在请求结束时清理用户数据

拦截器实例 

• 类似这种显示用户信息的在多个页面上都要显示，如果每打开一个页面都重新发送一次请求获取数据的话，耦合度比较高.
• 可以利用统一集中的低耦合度方式实现(拦截器，可以拦截请求，在请求开始和结束的位置插入一些代码,从而批量解决多个请求共有的业务，以低耦度的方式解决通用的问题)

1. 在interceptor包下创建一个拦截器

@Component
public class AlphaInterceptor implements HandlerInterceptor {
    private static final Logger logger = LoggerFactory.getLogger(AlphaInterceptor.class);
    //在Controller处理请求之前执行，如果返回为false的话，请求就不会被处理
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        logger.debug("preHandle：" + handler.toString());
        return true;
    }
    //在controller之后执行,主要的请求已经处理完了，下一步就是要去调用模板引擎了，所以有ModelAndView
    //在模板引擎执行之前执行.额外地装入一些数据，比如用户的基本信息。
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        logger.debug("postHandle：" + handler.toString());
    }
    //在模板引擎执行之后执行
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        logger.debug("afterCompletion：" + handler.toString());
    }
}

hander表示的是拦截的目标，比如login方法

2. 在config包下创建一个拦截器配置类，配置需要拦截哪些请求

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Autowired
    private AlphaInterceptor alphaInterceptor;   
   
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //排除所有目录下的所有文件夹，将拦截器注册进去
        //排除掉静态资源不进行处理
        // /**所有目录下的静态资源
        registry.addInterceptor(alphaInterceptor).excludePathPatterns("/**/*.css", "/**/*.js", "/**/*.jpg", "/**/*.jpeg", "/**/*.png")
                .addPathPatterns("/register", "/login");//表示只拦截register下的内容
    }
}

拦截器应用-显示用户登录信息

1. 捋清思路

• 浏览器携带cookie访问服务器，服务器获得cookie中的ticket凭证，从数据中查询关联到用户（userid），进而查询到User对象
• 在接下来的每次调用模板引擎之前将用户信息装入Model中。
• 关键在于(用户登陆的时候，存入了ticket,再下次访问的时候可获取到ticket值)。这套逻辑应被复用，利用拦截器来实现。

2. 创建LoginInterceptor

（1）preHandle方法之中，保存用户数据

• 封装从request中获取cookie的工具类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;
    }
}

UserService

    public LoginTicket findLoginTicket(String ticket){
        return loginTicketMapper.selectByTicket(ticket);
    }

注入UserService

    @Autowired
    private UserService userService;

• 服务器在处理请求的时候会创建一个线程来处理用户的请求，请求响应了数据，有了返回值之后，线程才会被销毁。
• 在多并发的情况下，需要考虑线程的隔离，利用ThreadLocal工具(以线程为key存取值)来实现。
• 创建一个HostHolder工具类， 代替session对象。

//用于代替session对象，持有用户信息，由容器进行加载
@Component
public class HostHolder {
    //每个线程里面存储一个User对象
    //以线程为key存取值的
    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();
    }
}

 注入HostHolder

    @Autowired
    private HostHolder hostHolder;   
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
                             Object handler) throws Exception {
        String ticket = CookieUtil.getValue(request, "ticket");
        if(ticket != null){
            //查询凭证
            LoginTicket loginTicket = userService.findLoginTicket(ticket);
            //检查凭证是否有效（有效了以后才能暂存,否则就和没登录一样）
            if(loginTicket != null && loginTicket.getStatus() == 0
                    && loginTicket.getExpired().after(new Date())){//超时时间晚于当前时间
                User user = userService.findUserById(loginTicket.getUserId());
                //需要把User进行暂存，表示在本次请求中持有用户，把对象存储在当前线程ThreadLocal之中。
                //之后在处理请求的过程中随时都可能需要使用
                hostHolder.setUser(user);
                //构建用户认证的结果，并存入SecurityContext,以便于Security进行授权
            }
        }
        return true;
    }

（2） 在postHandle方法之中使用保存的User对象信息

从hostHod

    @Override //在模板引擎调用之前把数据存储在hostHolder之中的数据放入Model之中
    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);
        }
    }

（3） 在afterCompletion()，模板引擎渲染完之后清除掉用户的数据

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
                                Object handler, Exception ex) throws Exception {
        //在模板执行完之后将数据清理掉
        hostHolder.clear();
    }

3. 配置LoginInterceptor

• 在WebMvcConfig类之中

    @Autowired
    private LoginTicketInterceptor loginTicketInterceptor;

在addInterceptors方法中，添加（拦截全部请求）

        registry.addInterceptor(loginTicketInterceptor)
                .excludePathPatterns("/**/*.css", "/**/*.js", "/**/*.jpg", "/**/*.jpeg", "/**/*.png");

4.  页面显示用户信息

• 处理情况:未登录不显示用户的信息，登录才显示(根据Model里面是否有loginUser来判断)

<div class="collapse navbar-collapse" id="navbarSupportedContent">
	<ul class="navbar-nav mr-auto">
		<li class="nav-item ml-3 btn-group-vertical">
			<a class="nav-link" th:href="@{/index}">首页</a>
		</li>
		<li class="nav-item ml-3 btn-group-vertical" th:if="${loginUser!=null}">
			<a class="nav-link position-relative" th:href="@{/letter/list}">消息
				<span class="badge badge-danger" th:text="${allUnreadCount!=0?allUnreadCount:''}">12</span>
			</a>
		</li>
		<li class="nav-item ml-3 btn-group-vertical" th:if="${loginUser==null}">
			<a class="nav-link" th:href="@{/register}">注册</a>
		</li>
		<li class="nav-item ml-3 btn-group-vertical" th:if="${loginUser==null}">
			<a class="nav-link" th:href="@{/login}">登录</a>
		</li>
		<li class="nav-item ml-3 btn-group-vertical dropdown" th:if="${loginUser!=null}">
			<a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
				<img th:src="${loginUser.headerUrl}" class="rounded-circle" style="width:30px;"/>
			</a>
			<div class="dropdown-menu" aria-labelledby="navbarDropdown">
				<a class="dropdown-item text-center"
				   th:href="@{|/user/profile/${loginUser.id}|}">个人主页</a>
				<a class="dropdown-item text-center" th:href="@{/user/setting}">账号设置</a>
				<a class="dropdown-item text-center" th:href="@{/logout}">退出登录</a>
				<div class="dropdown-divider"></div>
				<span class="dropdown-item text-center text-secondary"
					  th:utext="${loginUser.username}">nowcoder</span>
			</div>
		</li>
	</ul>
	<!-- 搜索 -->
	<form class="form-inline my-2 my-lg-0" th:action="@{/search}" method="get">
		<input class="form-control mr-sm-2" type="search" aria-label="Search" name="keyword" th:value="${keyword}"/>
		<button class="btn btn-outline-light my-2 my-sm-0" type="submit">搜索</button>
	</form>
</div>