第二十一篇:单点登录系统的具体实现(2)

前言:
前面我们已经实现了数据的校验和注册功能,下面是实现登录功能;用户的登录涉及到三部分
1.前台工程
2.单点登录服务
3.redis服务;相比于传统服务,我们没有把用户信息存在session中,而是放在redis中

image.png

登录的流程:
登录的处理流程:
1、登录页面提交用户名密码。
2、登录成功后生成token。Token相当于原来的jsessionid,字符串,可以使用uuid。
3、把用户信息保存到redis。Key就是token,value就是TbUser对象转换成json。
4、使用String类型保存Session信息。可以使用“前缀:token”为key
5、设置key的过期时间。模拟Session的过期时间。一般半个小时。
6、把token写入cookie中。
7、Cookie需要跨域。例如www.taotao.com\sso.taotao.com\order.taotao.com,可以使用工具类。
8、Cookie的有效期。关闭浏览器失效。
9、登录成功。

1.实现登录功能

  • 功能分析
    请求的url:/user/login
    请求的方法:POST
    参数:username、password,表单提交的数据。可以使用方法的形参接收。
    返回值:json数据,使用TaotaoResult包含一个token。
  • Dao层
    查询tb_user表。单表查询。可以使用逆向工程。
  • Service层
    参数:
    1、用户名:String username
    2、密码:String password
    返回值:TaotaoResult,包装token。
    业务逻辑:
    1、判断用户名密码是否正确。
    2、登录成功后生成token。Token相当于原来的jsessionid,字符串,可以使用uuid。
    3、把用户信息保存到redis。Key就是token,value就是TbUser对象转换成json。
    4、使用String类型保存Session信息。可以使用“前缀:token”为key
    5、设置key的过期时间。模拟Session的过期时间。一般半个小时。
    6、返回TaotaoResult包装token。
@Override
    public TaotaoResult login(String username, String password) {
        // 1、判断用户名密码是否正确。
        TbUserExample example = new TbUserExample();
        Criteria criteria = example.createCriteria();
        criteria.andUsernameEqualTo(username);
        //查询用户信息
        List<TbUser> list = userMapper.selectByExample(example);
        if (list == null || list.size() == 0) {
            return TaotaoResult.build(400, "用户名或密码错误");
        }
        TbUser user = list.get(0);
        //校验密码
        if (!user.getPassword().equals(DigestUtils.md5DigestAsHex(password.getBytes()))) {
            return TaotaoResult.build(400, "用户名或密码错误");
        }
        // 2、登录成功后生成token。Token相当于原来的jsessionid,字符串,可以使用uuid。
        String token = UUID.randomUUID().toString();
        // 3、把用户信息保存到redis。Key就是token,value就是TbUser对象转换成json。
        // 4、使用String类型保存Session信息。可以使用“前缀:token”为key
        user.setPassword(null);
        jedisClient.set(USER_INFO + ":" + token, JsonUtils.objectToJson(user));
        // 5、设置key的过期时间。模拟Session的过期时间。一般半个小时。
        jedisClient.expire(USER_INFO + ":" + token, SESSION_EXPIRE);
        // 6、返回TaotaoResult包装token。
        return TaotaoResult.ok(token);
    }

login接口中用到了配置文件,如下图所示。


image.png
#redis key的名称
USER_SESSION=USER_SESSION
#session的过期时间
SESSION_EXPIRE=1800
  • 发布服务和引用服务
    不用做任何修改~
  • Controller
    请求的url:/user/login
    请求的方法:POST
    参数:username、password,表单提交的数据。可以使用方法的形参接收。
    HttpServletRequest、HttpServletResponse
    返回值:json数据,使用TaotaoResult包含一个token。
    我们在登录的时候需要把token保存到cookie中,为了方便我们操作,我们封住了了一个工具类
    image.png
package com.taotao.utils;

import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.net.URLEncoder;

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;


/**
 * 
 * Cookie 工具类
 *
 */
public final class CookieUtils {

    /**
     * 得到Cookie的值, 不编码
     * 
     * @param request
     * @param cookieName
     * @return
     */
    public static String getCookieValue(HttpServletRequest request, String cookieName) {
        return getCookieValue(request, cookieName, false);
    }

    /**
     * 得到Cookie的值,
     * 
     * @param request
     * @param cookieName
     * @return
     */
    public static String getCookieValue(HttpServletRequest request, String cookieName, boolean isDecoder) {
        Cookie[] cookieList = request.getCookies();
        if (cookieList == null || cookieName == null) {
            return null;
        }
        String retValue = null;
        try {
            for (int i = 0; i < cookieList.length; i++) {
                if (cookieList[i].getName().equals(cookieName)) {
                    if (isDecoder) {
                        retValue = URLDecoder.decode(cookieList[i].getValue(), "UTF-8");
                    } else {
                        retValue = cookieList[i].getValue();
                    }
                    break;
                }
            }
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }
        return retValue;
    }

    /**
     * 得到Cookie的值,
     * 
     * @param request
     * @param cookieName
     * @return
     */
    public static String getCookieValue(HttpServletRequest request, String cookieName, String encodeString) {
        Cookie[] cookieList = request.getCookies();
        if (cookieList == null || cookieName == null) {
            return null;
        }
        String retValue = null;
        try {
            for (int i = 0; i < cookieList.length; i++) {
                if (cookieList[i].getName().equals(cookieName)) {
                    retValue = URLDecoder.decode(cookieList[i].getValue(), encodeString);
                    break;
                }
            }
        } catch (UnsupportedEncodingException e) {
             e.printStackTrace();
        }
        return retValue;
    }

    /**
     * 设置Cookie的值 不设置生效时间默认浏览器关闭即失效,也不编码
     */
    public static void setCookie(HttpServletRequest request, HttpServletResponse response, String cookieName,
            String cookieValue) {
        setCookie(request, response, cookieName, cookieValue, -1);
    }

    /**
     * 设置Cookie的值 在指定时间内生效,但不编码
     */
    public static void setCookie(HttpServletRequest request, HttpServletResponse response, String cookieName,
            String cookieValue, int cookieMaxage) {
        setCookie(request, response, cookieName, cookieValue, cookieMaxage, false);
    }

    /**
     * 设置Cookie的值 不设置生效时间,但编码
     */
    public static void setCookie(HttpServletRequest request, HttpServletResponse response, String cookieName,
            String cookieValue, boolean isEncode) {
        setCookie(request, response, cookieName, cookieValue, -1, isEncode);
    }

    /**
     * 设置Cookie的值 在指定时间内生效, 编码参数
     */
    public static void setCookie(HttpServletRequest request, HttpServletResponse response, String cookieName,
            String cookieValue, int cookieMaxage, boolean isEncode) {
        doSetCookie(request, response, cookieName, cookieValue, cookieMaxage, isEncode);
    }

    /**
     * 设置Cookie的值 在指定时间内生效, 编码参数(指定编码)
     */
    public static void setCookie(HttpServletRequest request, HttpServletResponse response, String cookieName,
            String cookieValue, int cookieMaxage, String encodeString) {
        doSetCookie(request, response, cookieName, cookieValue, cookieMaxage, encodeString);
    }

    /**
     * 删除Cookie带cookie域名
     */
    public static void deleteCookie(HttpServletRequest request, HttpServletResponse response,
            String cookieName) {
        doSetCookie(request, response, cookieName, "", -1, false);
    }

    /**
     * 设置Cookie的值,并使其在指定时间内生效
     * 
     * @param cookieMaxage cookie生效的最大秒数
     */
    private static final void doSetCookie(HttpServletRequest request, HttpServletResponse response,
            String cookieName, String cookieValue, int cookieMaxage, boolean isEncode) {
        try {
            if (cookieValue == null) {
                cookieValue = "";
            } else if (isEncode) {
                cookieValue = URLEncoder.encode(cookieValue, "utf-8");
            }
            Cookie cookie = new Cookie(cookieName, cookieValue);
            if (cookieMaxage > 0)
                cookie.setMaxAge(cookieMaxage);
            if (null != request) {// 设置域名的cookie
                String domainName = getDomainName(request);
                System.out.println(domainName);
                if (!"localhost".equals(domainName)) {
                    cookie.setDomain(domainName);
                }
            }
            cookie.setPath("/");
            response.addCookie(cookie);
        } catch (Exception e) {
             e.printStackTrace();
        }
    }

    /**
     * 设置Cookie的值,并使其在指定时间内生效
     * 
     * @param cookieMaxage cookie生效的最大秒数
     */
    private static final void doSetCookie(HttpServletRequest request, HttpServletResponse response,
            String cookieName, String cookieValue, int cookieMaxage, String encodeString) {
        try {
            if (cookieValue == null) {
                cookieValue = "";
            } else {
                cookieValue = URLEncoder.encode(cookieValue, encodeString);
            }
            Cookie cookie = new Cookie(cookieName, cookieValue);
            if (cookieMaxage > 0)
                cookie.setMaxAge(cookieMaxage);
            if (null != request) {// 设置域名的cookie
                String domainName = getDomainName(request);
                System.out.println(domainName);
                if (!"localhost".equals(domainName)) {
                    cookie.setDomain(domainName);
                }
            }
            cookie.setPath("/");
            response.addCookie(cookie);
        } catch (Exception e) {
             e.printStackTrace();
        }
    }

    /**
     * 得到cookie的域名
     */
    private static final String getDomainName(HttpServletRequest request) {
        String domainName = null;

        String serverName = request.getRequestURL().toString();
        if (serverName == null || serverName.equals("")) {
            domainName = "";
        } else {
            serverName = serverName.toLowerCase();
            serverName = serverName.substring(7);
            final int end = serverName.indexOf("/");
            serverName = serverName.substring(0, end);
            final String[] domains = serverName.split("\\.");
            int len = domains.length;
            if (len > 3) {
                // www.xxx.com.cn
                domainName = "." + domains[len - 3] + "." + domains[len - 2] + "." + domains[len - 1];
            } else if (len <= 3 && len > 1) {
                // xxx.com or xxx.cn
                domainName = "." + domains[len - 2] + "." + domains[len - 1];
            } else {
                domainName = serverName;
            }
        }

        if (domainName != null && domainName.indexOf(":") > 0) {
            String[] ary = domainName.split("\\:");
            domainName = ary[0];
        }
        return domainName;
    }

}

image.png

下面利用这个工具类实现登录

@RequestMapping(value="/user/login", method=RequestMethod.POST)
    @ResponseBody
    public TaotaoResult login(String username, String password,
            HttpServletRequest request, HttpServletResponse response) {
        // 1、接收两个参数。
        // 2、调用Service进行登录。
        TaotaoResult result = userService.login(username, password);
        // 3、从返回结果中取token,写入cookie。Cookie要跨域。
        String token = result.getData().toString();
        CookieUtils.setCookie(request, response, COOKIE_TOKEN_KEY, token);
        // 4、响应数据。Json数据。TaotaoResult,其中包含Token。
        return result;
        
    }

image.png

下面我们来测试,由于在taotao-common中添加了工具类,因此需要重新打包taotao-common工程到本地maven仓库,由于在taotao-sso-interface添加了接口,因此我们需要把taotao-sso工程重新打包到本地maven仓库。
在启动工程前要保证zookeeper和redis服务器处于启动状态!!!

  • 测试
    打包完后,我们启动taotao-sso工程和taotao-sso-web工程,启动之后,我们还是使用RestClient3.5来测试。我们修改下URL地址将/user/register修改为/user/login,然后点击下面那个圈住的图标。


    image.png

    可以看到弹出一个小框,我们点击"是"


    image.png

    登录我们只用用户名和密码,不用电话和邮箱,因此我们把电话和邮箱两个参数去掉,选中email和phone两行,右键点击"Remove Selected"。
    image.png

    去掉email和phone之后,双击value那一个框进入编辑状态,修改username的值为"zhangsan6",如下图,点击"Generate"。
    image.png

    点击执行按钮,可以看到返回的结果状态码是200,data中存放的是token的值。说明登录成功了,同时也说明我们的登录接口正确


    image.png

2.通过token获取用户的信息

  • 功能分析
    请求的url:/user/token/{token}
    参数:String token需要从url中取。
    返回值:json数据。使用TaotaoResult包装Tbuser对象。
    业务逻辑:
    1、从url中取参数。
    2、根据token查询redis。
    3、如果查询不到数据。返回用户已经过期。
    4、如果查询到数据,说明用户已经登录。
    5、需要重置key的过期时间。
    6、把json数据转换成TbUser对象,然后使用TaotaoResult包装并返回。
  • Dao层
    使用JedisClient对象。(因为我们的数据已经保存在redis中了,这样就不用再访问数据库)
  • Service层
    参数:String token
    返回值:TaotaoResult
@Override
    public TaotaoResult getUserByToken(String token) {
        // 2、根据token查询redis。
        String json = jedisClient.get(USER_INFO + ":" + token);
        if (StringUtils.isBlank(json)) {
            // 3、如果查询不到数据。返回用户已经过期。
            return TaotaoResult.build(400, "用户登录已经过期,请重新登录。");
        }
        // 4、如果查询到数据,说明用户已经登录。
        // 5、需要重置key的过期时间。
        jedisClient.expire(USER_INFO + ":" + token, SESSION_EXPIRE);
        // 6、把json数据转换成TbUser对象,然后使用TaotaoResult包装并返回。
        TbUser user = JsonUtils.jsonToPojo(json, TbUser.class);
        return TaotaoResult.ok(user);
    }

-Controller
请求的url:/user/token/{token}
参数:String token需要从url中取。
返回值:json数据。使用TaotaoResult包装Tbuser对象。

    @RequestMapping("/user/token/{token}")
    @ResponseBody
    public TaotaoResult getUserByToken(@PathVariable String token) {
        TaotaoResult result = userService.getUserByToken(token);
        return result;
    }

3.安全退出

所谓的安全退出就是将token从redis中删除

  • 功能分析
    请求的url:/user/logout/{token}
    参数:String token需要从url中取。
    返回值:json数据。使用TaotaoResult包装Tbuser对象。
    业务逻辑:
    1、从url中取参数。
    2、根据key删除redis中token中的数据(直接设置为过期)
    4.使用TaotaoResult返回结果
  • Service层
 public TaotaoResult logout(String token) {
        String key = USER_SESSION + ":" + token;
        //根据key删除redis中token中的数据(直接设置为过期)
        jedisClient.expire(key,0);
        return TaotaoResult.ok();
    }
  • Controller层
 //安全退出
    @RequestMapping(value = "/user/logout/{token}",method = RequestMethod.GET)
    @ResponseBody
    public TaotaoResult logout(@PathVariable String token){
        TaotaoResult result = userService.logout(token);
        return result;
    }  
  • 测试
    我们又增加了一个新的接口,记得要install一下,把工程打包到本地
    为了测试,我们还需要重新发送下登录请求,获取一个新的token(原来登录的token已经过期了,设置的过期时间是30分钟),如下图所示。
    image.png

    我们使用新的token来测试安全退出,在地址栏访问http://localhost:8088/user/logout/ba9bb30f-1a61-4b61-9931-6b94d1aeefdf,结果如下图所示
    image.png

    这时我们再尝试通过该token来获取用户信息,在地址栏访问http://localhost:8088/user/token/ba9bb30f-1a61-4b61-9931-6b94d1aeefdf,结果如下图所示,显示token已过期(从登录到现在还不到30分钟),这说明我们的安全退出没问题了。
    image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容