我们先来看下用户登录流程图,如下图所示。用户登录涉及到三个部分,第一个部分是淘淘商城前台工程,第二个部分是单点登录服务,第三个部分是Redis服务。具体流程下图已经说的很明白了,我就不再啰嗦一遍了,相比于传统的登录,我们并没有把用户登录信息存在Session当中,而是存放到了Redis数据库当中。
上图中要生成的key就是token,中文翻译过来是令牌的意思,也可以叫做ticket(票据、凭证)。
对于上面的用户登录流程图,我仍粗略作一下解释,用户登录的处理流程大致可分为以下几个步骤:
下面我们就来实现服务端的登录业务。
首先我们来编写dao层的代码。由于用户登录只涉及到单表操作,因此我们使用逆向工程生成的dao层代码即可。
然后我们来编写service层的代码。在taotao-sso-interface工程的com.taotao.sso.service包下新建一个用户登录的接口,例如UserLoginService,如下图所示。
对应地,我们要在taotao-sso-service工程的com.taotao.sso.service.impl包中编写以上接口的一个实现类,例如UserLoginServiceImpl。
package com.taotao.sso.service.impl;
import java.util.List;
import java.util.UUID;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
import org.springframework.util.DigestUtils;
import com.taotao.common.pojo.TaotaoResult;
import com.taotao.common.utils.JsonUtils;
import com.taotao.mapper.TbUserMapper;
import com.taotao.pojo.TbUser;
import com.taotao.pojo.TbUserExample;
import com.taotao.pojo.TbUserExample.Criteria;
import com.taotao.sso.jedis.JedisClient;
import com.taotao.sso.service.UserLoginService;
@Service
public class UserLoginServiceImpl implements UserLoginService {
@Autowired
private TbUserMapper userMapper;
@Autowired
private JedisClient client;
@Value("${USER_INFO}")
private String USER_INFO;
@Value("${EXPIRE_TIME}")
private Integer EXPIRE_TIME;
@Override
public TaotaoResult login(String username, String password) {
// 1. 注入Mapper
// 2. 校验用户名和密码是否为空
if (StringUtils.isEmpty(username) || StringUtils.isEmpty(password)) {
return TaotaoResult.build(400, "用户名或密码错误");
}
// 3. 先校验用户名
TbUserExample example = new TbUserExample();
Criteria criteria = example.createCriteria();
criteria.andUsernameEqualTo(username);
List<TbUser> list = userMapper.selectByExample(example); // 发送的sql语句:select * from tb_user where username = zhangsan
if (list == null && list.size() == 0) {
return TaotaoResult.build(400, "用户名或密码错误");
}
// 4. 再校验密码
TbUser user = list.get(0);
// 先对密码进行MD5加密再比较
String md5DigestAsHex = DigestUtils.md5DigestAsHex(password.getBytes());
if (!md5DigestAsHex.equals(user.getPassword())) { // 表示用户的密码不正确
return TaotaoResult.build(400, "用户名或密码错误");
}
/*
* 5. 如果校验成功,那么先生成token(即根据UUID算法生成的key),还需要设置token的有效期来模拟Session,
* token存在哪儿?用户的数据是存在Redis数据库里面的,key为token,value为代表用户信息的json数据。
* 再将token设置到Cookie当中(在表现层中设置,而且Cookie还需要跨越)
*/
String token = UUID.randomUUID().toString();
/*
* 大家想一想,我们到时候这个key的数据是不是要校验啊,校验的时候,
* 如果说你把用户的数据都存放在Redis数据库中了,那么很显然密码也会存进去。这样做并不好,因为太危险了!!!
*
* 最好密码就设置为空,不要把密码存进去,因为将来我们校验身份的时候,要获取用户的数据,
* 这时就会把密码拿到,虽然它是加密的, 但是也不好,所以要把密码设置为空
*/
user.setPassword(null); // 为了安全,就不要把密码保存到Redis数据库里面去了,因为这样太危险了,因此我们先把密码置空
// 使用Jedis客户端设置存放用户数据到Redis数据库中,而且为了更好地管理key,我们最好加一个前缀,例如"session:token"
client.set(USER_INFO + ":" + token, JsonUtils.objectToJson(user));
// 设置token的有效期来模拟Session,一般是半个小时
client.expire(USER_INFO + ":" + token, EXPIRE_TIME);
return TaotaoResult.ok(token);
}
}
以上UserLoginServiceImpl类的代码中USER_INFO和EXPIRE_TIME这两个字段的值是配置在了resource.properties这个配置文件中,如下图所示。
写完service层中的代码之后,我们还得发布一下服务,即在applicationContext-service.xml配置文件中添加如下一行配置:
<dubbo:service interface="com.taotao.sso.service.UserLoginService" ref="userLoginServiceImpl" timeout="300000" />
截图如下:
这样我们的service层代码就算是写完了。
下面我们接着来编写controller层的代码。首先我们添加对Dubbo服务的引用,即在taotao-sso-web工程下的springmvc.xml配置文件中添加如下一行配置:
<dubbo:reference interface="com.taotao.sso.service.UserLoginService" id="userLoginService" />
截图如下:
然后咱们来看一下用户登录的接口文档,如下图所示。
由于我们需要把token保存到Cookie当中,为了更加方便地操作Cookie,所以我们特意封装了一个工具类,即CookieUtils。考虑到该工具类有可能被多个服务调用,因此最好把该工具类放到taotao-common工程中,如下图所示。
可以看到当前导包是有错误的,要解决掉这个错误就需要在taotao-common工程中添加对servlet-api的依赖,添加完依赖之后CookieUtils这个工具类就不会报错了,如下图所示。
为了方便大家复制,现将CookieUtils工具类的代码贴出,如下所示。
package com.taotao.common.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);//.taotao.com
}
}
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;
}
}
接着我们在taotao-sso-web工程的src/main/java目录下的com.taotao.sso.controller包中新建一个Controller,例如UserLoginController。
为方便大家复制,现将以上Controller类的代码贴出,如下所示。
package com.taotao.sso.controller;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import com.taotao.common.pojo.TaotaoResult;
import com.taotao.common.utils.CookieUtils;
import com.taotao.sso.service.UserLoginService;
@Controller
public class UserLoginController {
@Autowired
private UserLoginService loginService;
@Value("${TT_TOKEN_KEY}")
private String TT_TOKEN_KEY;
/**
* url:/user/login
* 参数:
* username
* password
* 返回值:json数据
* 请求限定的方法:post
*/
@RequestMapping(value="/user/login", method=RequestMethod.POST)
@ResponseBody
public TaotaoResult login(HttpServletRequest request, HttpServletResponse response, String username, String password) {
// 1. 引入服务
// 2. 注入服务
// 3, 调用服务
TaotaoResult result = loginService.login(username, password);
// 4. 需要设置token到Cookie中,可以使用一个工具类,需要注意的是Cookie需要跨域
if (result.getStatus() == 200) {
// 其实,现在Cookie是跨域的
CookieUtils.setCookie(request, response, TT_TOKEN_KEY, result.getData().toString());
}
return result;
}
}
以上Controller类的代码中TT_TOKEN_KEY这个字段的值是配置在resource.properties这个配置文件中了,如下图所示。
controller层的代码编写完之后,接下来我们就要进行测试了。由于在taotao-common工程中添加了一个工具类,因此需要重新打包taotao-common工程到本地maven仓库中,又由于在taotao-sso-interface工程中新添加了一个接口,因此我们还需要把taotao-sso工程重新打包到本地maven仓库。注意:在启动工程前要保证Zookeeper注册中心和Redis服务器处于启动状态!!!
以上准备工作做好之后,我们启动taotao-sso工程和taotao-sso-web工程,启动成功之后,我们还是使用postman这款接口测试工具来测试,登录时我们只用用户名和密码,不用电话和邮箱,添加完用户名和密码这两个参数之后,点击Send按钮,如下图所示。
可以看到返回的结果状态码是200,data中存放的是token的值,说明用户登录成功了,同时也说明我们开发的用户登录接口是正确的。
登录成功之后,我们可以利用Redis Desktop Manager可视化工具来查看一下token是否已经被保存起来了,如下图所示,发现已经被保存起来了。