淘淘商城系列——单点登录之用户登录

我们先来看下用户登录流程图，如下图所示。用户登录涉及到三个部分，第一部分是淘淘商城前台工程，第二部分是单点登录服务，第三部分是Redis服务。具体流程下图已经说的很明白了，我就不再啰嗦一遍了，相比于传统的登录，我们没有把用户登录信息存在session当中，而是存放到了Redis数据库当中。



对于上面的用户登录流程图，我仍粗略作一下解释，用户登录的处理流程大致可分为以下几个步骤：

用户在登录页面提交用户名和密码。

用户登录成功后生成token，token就相当于原来的jsessionid，它是一个字符串，可以使用uuid算法来生成。

把用户信息保存到Redis数据库里面，key就是token，value就是TbUser对象转换成的json，Redis存储信息时建议使用String类型来存储，并且可以使用“前缀:token”作为key。

设置key的过期时间，相当于模拟Session的过期时间，一般置为半个小时。

把token写入cookie中。

cookie需要跨域，并且是跨多个二级域名，例如www.taotao.com、sso.taotao.com、order.taotao.com。

设置cookie的有效期，建议设置为关闭浏览器cookie即失效。

登录成功。

下面我们就来实现服务端的登录业务。

由于用户登录只涉及到单表操作，因此我们使用逆向工程生成的dao层代码即可。

下面我们来编写Service层的代码。首先在taotao-sso-interface工程的com.taotao.sso.service包下新建一个用户登录的接口——UserLoginService.java，如下图所示。



紧接着在taotao-sso-service工程的com.taotao.sso.service.impl包中编写UserLoginService接口的实现类——UserLoginServiceImpl.java，实现完之后，UserLoginServiceImpl类的所有代码如下：

/**
* 用户登录处理Service
* <p>Title: UserLoginServiceImpl</p>
* <p>Description: </p>
* <p>Company: www.itcast.cn</p>
* @version 1.0
*/
@Service
public class UserLoginServiceImpl implements UserLoginService {

@Autowired
private TbUserMapper userMapper;

@Autowired
private JedisClient jedisClient;

@Value("${SESSION_PRE}")
private String SESSION_PRE;

@Value("${SESSION_EXPIRE}")
private Integer SESSION_EXPIRE;

@Override
public TaotaoResult login(String username, String password) {
// 判断用户名和密码是否正确
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, "用户名或密码错误");
}
// 校验密码，密码要进行md5加密后再校验
TbUser user = list.get(0);
if (!DigestUtils.md5DigestAsHex(password.getBytes()).equals(user.getPassword())) {
return TaotaoResult.build(400, "用户名或密码错误");
}
// 生成一个token
String token = UUID.randomUUID().toString();
// 把用户信息保存到Redis数据库里面去
// key就是token，value就是用户对象转换成json
user.setPassword(null); // 为了安全，就不要把密码保存到Redis数据库里面去，因为这样太危险了，因此我们先把密码置空
jedisClient.set(SESSION_PRE + ":" + token, JsonUtils.objectToJson(user));
// 设置key的过期时间
jedisClient.expire(SESSION_PRE + ":" + token, SESSION_EXPIRE);
// 返回结果
return TaotaoResult.ok(token);
}

}

UserLoginServiceImpl类的代码中SESSION_PRE和SESSION_EXPIRE这两个字段的值配置在配置文件中，如下图所示。



下面我们便发布一下服务，如下图所示。即在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，我们特意封装了一个工具类，由于该工具类有可能被多个服务使用，因此我们最好把该工具类放到taotao-common工程中，如下图所示。



可以看到当前导包是有错误的，要解决这个问题就要在taotao-common工程中添加对servlet-api的依赖，添加完依赖之后CookieUtils类就不报错了，如下图所示。



为了方便大家复制，现将CookieUtils工具类的代码给出。

/**
*
* 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;
}

}

接下来我们要在taotao-sso-web工程的UserController类中添加如下图所示标注的代码。



为方便大家复制，现将UserController类的代码贴出。

/**
* 用户管理Controller
* <p>Title: UserController</p>
* <p>Description: </p>
* <p>Company: www.itcast.cn</p>
* @version 1.0
*/
@Controller
public class UserController {

@Autowired
private UserRegisterService userRegisterService;

@Autowired
private UserLoginService userLoginService;

@Value("${COOKIE_TOKEN_KEY}")
private String COOKIE_TOKEN_KEY;

@RequestMapping(value="/user/check/{param}/{type}", method=RequestMethod.GET)
@ResponseBody
public TaotaoResult checkUserInfo(@PathVariable String param, @PathVariable Integer type) {
TaotaoResult result = userRegisterService.checkUserInfo(param, type);
return result;
}

@RequestMapping(value="/user/register", method=RequestMethod.POST)
@ResponseBody
public TaotaoResult registerUser(TbUser user) {
TaotaoResult taotaoResult = userRegisterService.createUser(user);
return taotaoResult;
}

@RequestMapping(value="/user/login", method=RequestMethod.POST)
@ResponseBody
public TaotaoResult userLogin(String username, String password,
HttpServletRequest request, HttpServletResponse response) {
TaotaoResult taotaoResult = userLoginService.login(username, password);
// 取出token
String token = taotaoResult.getData().toString();
// 在返回结果之前，设置cookie(即将token写入cookie)
// 1.cookie怎么跨域？
// 2.如何设置cookie的有效期？
CookieUtils.setCookie(request, response, COOKIE_TOKEN_KEY, token);
// 返回结果
return taotaoResult;
}
}

UserController类的代码中COOKIE_TOKEN_KEY这个字段的值配置在resource.properties配置文件中，如下图所示。



下面我们来进行测试，由于在taotao-common中添加了一个工具类，因此需要重新打包taotao-common工程到本地maven仓库，又由于在taotao-sso-interface工程中新添加了一个接口，因此我们还需要把taotao-sso工程重新打包到本地maven仓库。注意：在启动工程前要保证zookeeper和Redis服务器处于启动状态！！！ Redis服务器的IP及端口要与applicationContext-redis.xml配置文件一致，如下图所示。



以上准备工作做好之后，我们启动taotao-sso工程和taotao-sso-web工程，启动成功之后，我们还是使用RESTClient3.5来测试，最关键的两步我已截图。登录我们只用用户名和密码，不用电话和邮箱，所以添加完用户名和密码这两个参数之后，点击”Generate”，如下图所示。



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



登录成功了，我们利用redis-desktop-manager工具来查看token是否已经被保存起来了，如下图所示，发现已经被保存起来了。