企业WEB项目单点登陆系统实现

阅读数: 次 2020-06-01

概述

在企业WEB项目中，我们的注册登录往往依靠独立的单点登陆系统实现，本博文将从头开始讲解如何一步步创建单点登录系统，独立的工程并发布登录、注册的接口。至于单点登录系统实现用户的登录、注册功能，我们将在下篇博文详细介绍(赶着六一赶紧发一篇😁)。

一、单点登录系统分析

1.什么是SSO

SSO英文全称Single Sign On，单点登录。SSO是在多个应用系统中，用户只需要登录一次就可以访问所有相互信任的应用系统。它包括可以将这次主要的登录映射到其他应用中用于同一个用户的登录的机制。它是目前比较流行的企业业务整合的解决方案之一。

2.传统的登录流程

传统流程中的问题：

单台tomcat，以上实现是没有任何问题的，但是我们现在是集群的tomcat，就会存在session共享问题：在集群环境中。需要把同一套代码部署到多台服务器上。每个工程都有自己独立的session。

在集群环境中每个工程都有自己的session，如果把用户信息写入session而不共享的话，会出现用户反复登录的情况。

3.解决session共享方案

3.1第一种解决方案

可以配置tomcat的session共享。配置tomcat集群。Tomcat配置好集群后，会不停的向集群中其他的tomcat广播自己的session信息。其他的tomcat做session同步。可以保证所有的tomcatsession中的内容都是一致的。

优点：不需要额外开发，只需要搭建tomcat集群即可。

缺点：tomcat 是全局session复制，集群内每个tomcat的session完全同步（也就是任何时候都完全一样的) 在大规模应用的时候，用户过多，集群内tomcat数量过多，session的全局复制会导致集群性能下降，因此，tomcat的数量不能太多，5个以下为好。

3.2第二种解决方案

1、实现单点登录系统，提供服务接口。把session数据存放在redis。

Redis可以设置key的生存时间、访问速度快效率高。

优点：redis存取速度快，不会出现多个节点session复制的问题。效率高。

缺点：需要程序员开发。

4.单点登录系统流程

二、SSO开发

单点登录系统是一个独立的工程。需要操作redis、连接数据库。

1.系统架构

创建taotao-sso工程

2.用到的技术

1、Mybatis，需要依赖taotao-manager-mapper模块。

2、Spring

3、Springmvc

4、Redis

3.配置文件

参考taotao-rest整合框架

注意这里需要用到事务

4.服务开发

4.1注册接口

4.1.1检查数据是否可用

请求方法	GET
URL	http://sso.taotao.com/user/check/{param}/{type}
参数说明	格式如：zhangsan/ 1，其中zhangsan是校验的数据，type为类型，可选参数1、2、3分别代表username、phone、email 可选参数callback：如果有此参数表示此方法为jsonp请求，需要支持jsonp。
示例	http://sso.taotao.com/user/check/zhangsan/1
返回值	{ status: 200 //200 成功 msg: “OK” // 返回信息消息 data: false // 返回数据，true：数据可用，false：数据不可用 }

4.1.2用户注册

请求方法	POST
URL	http://sso.taotao.com/user/register
参数	username //用户名 password //密码 phone //手机号 email //邮箱
参数说明
示例	http://sso.taotao.com/user/register
返回值	{ status: 400 msg: “注册失败. 请校验数据后请再提交数据.” data: null }

4.2用户登录

请求方法	POST
URL	http://sso.taotao.com/user/login
参数	username //用户名 password //密码
参数说明
示例	http://sso.taotao.com/user/login username=zhangsan&password=123
返回值	{ status: 200 msg: “OK” data: “fe5cb546aeb3ce1bf37abcb08a40493e” //登录成功，返回token }

4.3通过token查询用户信息

请求方法	GET
URL	http://sso.taotao.com/user/token/{token}
参数	token //用户登录凭证 callback//jsonp回调方法
参数说明	可选参数callback：如果有此参数表示此方法为jsonp请求，需要支持jsonp。
示例	http://sso.taotao.com/user/token/fe5cb546aeb3ce1bf37abcb08a40493e
返回值	{ status: 200 msg: “OK” data: “{“id”:1,”username”:”zhangzhijun”,”phone”:”15800807944”, “email”:”420840806@qq.com”,”created”:1414119176000,”updated”:1414119179000}” }

4.4安全退出

请求方法	GET
URL	http://sso.taotao.com/user/logout/{token}
参数	token //用户登录凭证 callback//jsonp回调方法
参数说明	可选参数callback：如果有此参数表示此方法为jsonp请求，需要支持jsonp。
示例	http://sso.taotao.com/user/logout/fe5cb546aeb3ce1bf37abcb08a40493e
返回值	{ status: 200 msg: “OK” data: “” }

5.开发注册接口

5.1数据校验

5.1.1需求分析

接收url中的两个参数：一个是要校验的内容，一个是要校验的数据类型。

type为类型，可选参数1、2、3分别代表username、phone、email

返回：TaotaoResult。Json格式的数据，需要支持jsonp。

请求的url：http://sso.taotao.com/user/check/{param}/{type}

5.1.2Service层

@Service
public class UserServiceImpl implements UserService {

	@Autowired
	private TbUserMapper userMapper;
	
	@Override
	public TaotaoResult checkData(String content, Integer type) {
		//创建查询条件
		TbUserExample example = new TbUserExample();
		Criteria criteria = example.createCriteria();
		//对数据进行校验：1、2、3分别代表username、phone、email
		//用户名校验
		if (1 == type) {
			criteria.andUsernameEqualTo(content);
		//电话校验
		} else if ( 2 == type) {
			criteria.andPhoneEqualTo(content);
		//email校验
		} else {
			criteria.andEmailEqualTo(content);
		}
		//执行查询
		List<TbUser> list = userMapper.selectByExample(example);
		if (list == null || list.size() == 0) {
			return TaotaoResult.ok(true);
		}
		return TaotaoResult.ok(false);
	}

}

5.1.3Controller层

从url中接收两个参数，调用Service进行校验，在调用Service之前，先对参数进行校验，例如type必须是1、2、3其中之一。返回TaotaoResult。需要支持jsonp。

@Controller
@RequestMapping("/user")
public class UserController {

	@Autowired
	private UserService userService;
	
	@RequestMapping("/check/{param}/{type}")
	@ResponseBody
    //考虑到jsonp，我们需要既能返回taotaoResult又能返回MappingJacksonValue 
	public Object checkData(@PathVariable String param, @PathVariable Integer type, String callback) {
		
		TaotaoResult result = null;
		
		//参数有效性校验
		if (StringUtils.isBlank(param)) {
			result = TaotaoResult.build(400, "校验内容不能为空");
		}
		if (type == null) {
			result = TaotaoResult.build(400, "校验内容类型不能为空");
		}
		if (type != 1 && type != 2 && type != 3 ) {
			result = TaotaoResult.build(400, "校验内容类型错误");
		}
		//校验出错
		if (null != result) {
			if (null != callback) {
				MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(result);
				mappingJacksonValue.setJsonpFunction(callback);
				return mappingJacksonValue;
			} else {
				return result; 
			}
		}
		//调用服务
		try {
			result = userService.checkData(param, type);
			
		} catch (Exception e) {
			result = TaotaoResult.build(500, ExceptionUtil.getStackTrace(e));
		}
		
		if (null != callback) {
			MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(result);
			mappingJacksonValue.setJsonpFunction(callback);
			return mappingJacksonValue;
		} else {
			return result; 
		}
	}
	
}

5.2用户注册

5.2.1需求分析

接收参数调用mapper向user表中添加记录。返回taotaoResult对象。如果成功200失败400异常500.

5.2.2Service层

@Override
public TaotaoResult createUser(TbUser user) {
    user.setCreated(new Date());
    user.setUpdated(new Date());
    //Spring自带的md5加密
    user.setPassword(DigestUtils.md5DigestAsHex(user.getPassword().getBytes()));
    userMapper.insert(user);
    return TaotaoResult.ok();
}

5.2.3Controller层

//创建用户
@RequestMapping(value="/register",method=RequestMethod.POST)
@ResponseBody
public TaotaoResult createUser(TbUser user) {
    try {
        TaotaoResult result = userService.createUser(user);
        return result;
    } catch (Exception e) {
        e.printStackTrace();
        return TaotaoResult.build(500, ExceptionUtil.getStackTrace(e));
    }
}

5.3测验

用RestClient来看效果

6.开发登录接口

6.1需求分析

是一个post请求，包含用户和密码。接收用户名和密码，到数据库中查询，根据用户名查询用户信息，查到之后进行密码比对，需要对密码进行md5加密后进行比对。比对成功后说明登录成功，需要生成一个token可以使用UUID。需要把用户信息写入redis，key就是token，value就是用户信息。返回token字符串。

创建resource.properties配置文件

#用户在session在redis中保存的key
REDIS_USER_SESSION_KEY=REDIS_USER_SESSION
#Session的过期时间，默认为30分钟
SSO_SESSION_EXPIRE=1800

6.2Service层

接收两个参数用户名、密码。调用dao层查询用户信息。生成token，把用户信息写入redis。返回token。使用TaotaoResult包装。

//用户登录
@Override
public TaotaoResult userLogin(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, "用户名或密码错误");
    }
    TbUser user = list.get(0);
    //对比密码
    if(!DigestUtils.md5DigestAsHex(password.getBytes()).equals(user.getPassword())) {
        return TaotaoResult.build(400, "用户名或密码错误");
    }
    //生成token
    String token = UUID.randomUUID().toString();
    //保存用户之前，把用户对象中的密码清空。
    user.setPassword(null);
    //把用户信息写入redis
    jedisClient.set(REDIS_USER_SESSION_KEY + ":" + token, JsonUtils.objectToJson(user));
    //设置session的过期时间
    jedisClient.expire(REDIS_USER_SESSION_KEY + ":" + token, SSO_SESSION_EXPIRE);
    //返回token
    return TaotaoResult.ok(token);
}

6.3Controller层

//用户登录
@RequestMapping(value="/login", method=RequestMethod.POST)
@ResponseBody
public TaotaoResult userLogin(String username, String password) {
    try {
        TaotaoResult result = userService.userLogin(username, password);
        return result;
    } catch (Exception e) {
        e.printStackTrace();
        return TaotaoResult.build(500, ExceptionUtil.getStackTrace(e));
    }
}

6.4测试

7.根据token查询用户

7.1业务分析

根据token判断用户是否登录或者session是否过期。接收token，根据token到redis中取用户信息。判断token字符串是否对应用户信息，如果不对应说明token非法或者session已过期。取到了说明用户就是正常的登录状态。返回用户信息，同时重置用户的过期时间。

7.2Service层

接收token，调用dao，到redis中查询token对应的用户信息。返回用户信息并更新过期时间。

@Override
public TaotaoResult getUserByToken(String token) {
    //根据token从redis中查询用户信息
    String json = jedisClient.get(REDIS_USER_SESSION_KEY + ":" + token);
    //判断是否为空
    if (StringUtils.isBlank(json)) {
        return TaotaoResult.build(400, "此session已经过期，请重新登录");
    }
    //更新过期时间
    jedisClient.expire(REDIS_USER_SESSION_KEY + ":" + token, SSO_SESSION_EXPIRE);
    //返回用户信息
    return TaotaoResult.ok(JsonUtils.jsonToPojo(json, TbUser.class));
}

7.3Controller层

@RequestMapping("/token/{token}")
@ResponseBody
public Object getUserByToken(@PathVariable String token, String callback) {
    TaotaoResult result = null;
    try {
        result = userService.getUserByToken(token);
    } catch (Exception e) {
        e.printStackTrace();
        result = TaotaoResult.build(500, ExceptionUtil.getStackTrace(e));
    }

    //判断是否为jsonp调用
    if (StringUtils.isBlank(callback)) {
        return result;
    } else {
        MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(result);
        mappingJacksonValue.setJsonpFunction(callback);
        return mappingJacksonValue;
    }
}

7.4测试

结语

乔碧萝50岁自称萝莉
罗志祥40岁自称男孩
我自己20岁自称儿童
过个儿童节不过分吧……