springboot实现用户统一认证、管理(单点登录)

34 篇文章 1 订阅

大家好,我是雄雄,欢迎关注微信公众号:雄雄的小课堂

前言

现在是:2022年5月25日13:44:16

最近和模拟登录杠上了,这不,又来了个需求,还是以这个技术点入手的。
需求大概是这样的:为了统一管理系统的用户,上游平台做了个统一认证平台,所有用户进入子系统只有一个入口,即:上游平台登录入口,新用户也是上游平台进行添加;子系统的用户登录和注册模块都屏蔽掉。

设计技能点

  1. 前端:Vue
  2. 后端:springboot (bladex框架)
  3. 数据库:mysql 5.7及以上

实现思路

  1. 上游平台通过回调接口,将用户和组织机构同步至子系统
  2. 上游平台通过url在地址栏中挂sessionid的方式访问子系统的登录页面
  3. 子系统检地址栏中是否有sessionid,如果有,则拿着sessionid去上游系统获取用户信息,然后在子系统中拿着用户信息自动登录
  4. 如果地址栏中没有sessionid,则需要带着子系统的登录地址,重定向至上游平台(上游平台怎么处理的,我就不知道了,我猜测,如果用户未在上游平台登录,则不带sessionid来的子系统,如果登录了则会带着过来。所以重定向到上游平台时,应该是让用户重新进行登录的)
  5. 当用户点击退出时,清除子系统的用户登录状态的同时还需要清除上游系统,且重定向至上游平台的登录页面

代码实现

回调接口实现了两个功能:

  • 同步组织机构
  • 同步用户信息

为了后期维护方便,前后端所有调用外部的地址,从接口中获取数据等均单独提取出来了,这样也能更好的实现复用。

  1. 统一接口管理SsoLoginConstant
	package org.springblade.modules.system.util;

	/**
	* @Description: TODO
	* @author: 穆雄雄
	* @date: 2022/5/17 下午 2:40
	 * 放一些公共的常量
	* @Return:
	*/
	public interface SsoLoginConstant {

		/**
		 * 统一认证平台的地址
		 */
		public final static String SSO_URL = "http://************";


		/**
		 * 登录鉴权
		 */

		public final static  String CHECKLOGIN_URL =SSO_URL+ "/check_login";

		/**
		 * 查询平台用户信息
		 */
		public final static  String QUERYUSER_URL =SSO_URL+ "/get_user";

		/**
		 * 查询平台组织机构信息
		 */
		public final static String QUERYDEPARTMENT_URL =SSO_URL+ "/get_department";

		/**
		 * 退出系统
		 */
		public final static String APILOGOUT_URL =SSO_URL+ "/api_logout";


	}

  1. 公用Service层接口:

	package org.springblade.modules.system.service;

	import org.springblade.core.tool.api.R;
	import org.springframework.web.bind.annotation.RequestBody;

	/**
	 * @author: muxiongxiong
	 * @date: 2022年05月21日 上午 8:41
	 * 公众号:雄雄的小课堂
	 * 博客:https://blog.csdn.net/qq_34137397
	 * 个人站:http://www.穆雄雄.com
	 * 个人站:http://www.muxiongxiong.cn
	 * @Description: 类的描述:单点登录业务层接口
	 */
	public interface ISsoLoginService {

		/**
		* @Description: 登录鉴权
		* @author: 穆雄雄
		* @date: 2022/5/21 上午 8:54
		No such property: code for class: Script1
		* @Return:
		*/
		String checkLogin(String ssoSessionKey);

		/**
		 * @Description: 查询平台用户信息
		 * @author: 穆雄雄
		 * @date: 2022/5/21 上午 8:42
		 * 查询平台用户信息
		 * @Return:
		 */
		String getUser(String projectKey);

		/**
		* @Description: 查询平台组织机构信息
		* @author: 穆雄雄
		* @date: 2022/5/21 上午 8:50
		* 查询平台用户信息
		* @Return: java.lang.String
		*/
		String getDepartment(String projectKey);

		/**
		* @Description: 上传平台用户信息
		* @author: 穆雄雄
		* @date: 2022/5/21 上午 9:24
		* @Return: java.lang.String
		*/
		R pullUserInfo(@RequestBody String val);

		/**
		 * @Description: 退出
		 * @author: 穆雄雄
		 * @date: 2022年5月25日15:34:58
		No such property: code for class: Script1
		 * @Return:
		 */
		String apiLogout(String ssoSessionKey);

	}


  1. Service层实现类:
	package org.springblade.modules.system.service.impl;

	import cn.hutool.http.HttpUtil;
	import com.alibaba.fastjson.JSONArray;
	import com.alibaba.fastjson.JSONObject;
	import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
	import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
	import com.baomidou.mybatisplus.core.conditions.update.LambdaUpdateWrapper;
	import org.apache.commons.lang.StringUtils;
	import org.springblade.core.tool.api.R;
	import org.springblade.modules.system.entity.Dept;
	import org.springblade.modules.system.entity.User;
	import org.springblade.modules.system.entity.UserService;
	import org.springblade.modules.system.service.IDeptService;
	import org.springblade.modules.system.service.ISsoLoginService;
	import org.springblade.modules.system.service.IUserService;
	import org.springblade.modules.system.util.SsoLoginConstant;
	import org.springframework.beans.factory.annotation.Autowired;
	import org.springframework.stereotype.Service;

	import java.util.HashMap;
	import java.util.Map;

	/**
	 * @author: muxiongxiong
	 * @date: 2022年05月21日 上午 8:51
	 * 公众号:雄雄的小课堂
	 * 博客:https://blog.csdn.net/qq_34137397
	 * 个人站:http://www.穆雄雄.com
	 * 个人站:http://www.muxiongxiong.cn
	 * @Description: 类的描述
	 */
	@Service
	public class SsoLoginServiceImpl implements ISsoLoginService {

		@Autowired
		private IUserService userService;

		@Autowired
		private IDeptService deptService;


		/**
		 * 登录鉴权
		 */
		@Override
		public String checkLogin(String ssoSessionKey) {
			JSONObject jsonObjectResult = new JSONObject();
			//请求接口地址
			String url = SsoLoginConstant.CHECKLOGIN_URL;
			Map<String, Object> paramMap = new HashMap<String, Object>();
			paramMap.put("ssoSessionKey", ssoSessionKey);
			try {
				String body = HttpUtil.createPost(url).form(paramMap).execute().body();
				if (StringUtils.isBlank(body)) {
					jsonObjectResult.put("code", 500);
					jsonObjectResult.put("msg", "请求失败");
					jsonObjectResult.put("data", "");
					jsonObjectResult.put("status", false);
					return jsonObjectResult.toJSONString();
				}
				JSONObject obj = JSONObject.parseObject(body);
				if (obj == null) {
					jsonObjectResult.put("code", 500);
					jsonObjectResult.put("msg", "请求失败");
					jsonObjectResult.put("data", "");
					jsonObjectResult.put("status", false);
					return jsonObjectResult.toJSONString();
				}
				String code = obj.get("code").toString();
				if ("200".equals(code)) {
					jsonObjectResult.put("code", 200);
					jsonObjectResult.put("msg", "请求成功");
					jsonObjectResult.put("data", obj.get("data"));
					jsonObjectResult.put("status", false);
					return jsonObjectResult.toJSONString();
				}else{
					jsonObjectResult.put("code", 500);
					jsonObjectResult.put("msg", "请求失败");
					jsonObjectResult.put("data", "");
					jsonObjectResult.put("status", false);
					return jsonObjectResult.toJSONString();
				}
			} catch (Exception e) {
				e.printStackTrace();
			}
			return jsonObjectResult.toJSONString();
		}

		/**
		 * 获取平台用户
		 */
		@Override
		public String getUser(String projectKey) {
			JSONObject jsonObjectResult = new JSONObject();
			//请求接口地址
			String url = SsoLoginConstant.QUERYUSER_URL;
			Map<String, Object> paramMap = new HashMap<String, Object>();
			paramMap.put("projectKey", projectKey);
			try {
				String body = HttpUtil.createGet(url).form(paramMap).execute().body();
				if (StringUtils.isBlank(body)) {
					jsonObjectResult.put("code", 500);
					jsonObjectResult.put("msg", "请求失败");
					jsonObjectResult.put("data", "");
					jsonObjectResult.put("status", false);
					return jsonObjectResult.toJSONString();
				}
				JSONObject obj = JSONObject.parseObject(body);
				if (obj == null) {
					jsonObjectResult.put("code", 500);
					jsonObjectResult.put("msg", "请求失败");
					jsonObjectResult.put("data", "");
					jsonObjectResult.put("status", false);
					return jsonObjectResult.toJSONString();
				}
				String code = obj.get("code").toString();
				if ("200".equals(code)) {
					jsonObjectResult.put("code", 200);
					jsonObjectResult.put("msg", "请求成功");
					jsonObjectResult.put("data", obj.get("data"));
					jsonObjectResult.put("status", false);
					return jsonObjectResult.toJSONString();
				}
			} catch (Exception e) {
				e.printStackTrace();
			}
			return jsonObjectResult.toJSONString();
		}

		/**
		 * 获取组织机构
		 */
		@Override
		public String getDepartment(String projectKey) {
			JSONObject jsonObjectResult = new JSONObject();
			//请求接口地址
			String url = SsoLoginConstant.QUERYDEPARTMENT_URL;
			Map<String, Object> paramMap = new HashMap<String, Object>();
			paramMap.put("projectKey", projectKey);
			try {
				String body = HttpUtil.createGet(url).form(paramMap).execute().body();
				if (StringUtils.isBlank(body)) {
					jsonObjectResult.put("code", 500);
					jsonObjectResult.put("msg", "请求失败");
					jsonObjectResult.put("data", "");
					jsonObjectResult.put("status", false);
					return jsonObjectResult.toJSONString();
				}
				JSONObject obj = JSONObject.parseObject(body);
				if (obj == null) {
					jsonObjectResult.put("code", 500);
					jsonObjectResult.put("msg", "请求失败");
					jsonObjectResult.put("data", "");
					jsonObjectResult.put("status", false);
					return jsonObjectResult.toJSONString();
				}
				String code = obj.get("code").toString();
				if ("200".equals(code)) {
					jsonObjectResult.put("code", 200);
					jsonObjectResult.put("msg", "请求成功");
					jsonObjectResult.put("data", obj.get("data"));
					jsonObjectResult.put("status", false);
					return jsonObjectResult.toJSONString();
				}
			} catch (Exception e) {
				e.printStackTrace();
			}
			return jsonObjectResult.toJSONString();
		}

		/**
		 * 上传平台用户信息
		 * @param val
		 * @return
		 */
		@Override
		public R pullUserInfo(String val) {
			//转换成集合类型
			JSONArray userListArray = JSONArray.parseArray(val);
			boolean flag = false;
			for (Object o : userListArray) {
				JSONObject jsonObject = (JSONObject) o;
				User user = new User();
				//add表示添加
				//update表示更新
				//delete表示删除
				String operate = jsonObject.getString("operate");
				//固定标识
				String type = jsonObject.getString("type");
				JSONObject dataObject = jsonObject.getJSONObject("data");
				if (type.equals("sso_user")) {
					Long id = dataObject.getLong("id");
					//用户账号
					String account = dataObject.getString("account");
					//用户名称
					String name = dataObject.getString("name");
					//所属部门
					String departmentId = dataObject.getString("departmentId");
					//手机号
					String mobile = dataObject.getString("mobile");
					//用户角色,1表示管理者,2表示使用者
					String isManager = dataObject.getString("isManager");
					//应用编号
					String project = dataObject.getString("project");

					//添加用户
					user.setId(id);
					user.setPhone(mobile);
					user.setTenantId("000000");
					user.setCode("");
					if(isManager.equals("1")){
						//管理员
						user.setRoleId("1529303109787967490");
					}else if(isManager.equals("2")){
						//一般用户
						user.setRoleId("1529302965017370625");
					}else{
						//会员(这个地方不会执行到,只要isManager不等于null)
						user.setRoleId("1355058724514836481");
					}
					user.setUserType(Integer.parseInt(isManager));
					user.setAccount(account);
					//密码是123456
					user.setPassword("10470c3b4b1fed12c3baac014be15fac67c6e815");
					user.setName(name);
					user.setRealName(name);

					user.setDeptId(departmentId);
					user.setStatus(1);
					//证明是那边过来的用户
					user.setRemark(type);
					switch (operate) {
						case "add":
							flag = userService.save(user);
							break;
						case "update":
							flag = userService.updateUser(user);
							break;
						case "delete":
							flag = userService.updateById(user);
							break;
						default:
							break;
					}
				} else if (type.equals("sso_department")) {
					Dept dept = new Dept();
					Long id = dataObject.getLong("id");
					//用户账号
					String title = dataObject.getString("title");
					//父级企业ID
					String parentId = dataObject.getString("parentId");
					//企业等级
					String level = dataObject.getString("level");
					//排序
					String sort = dataObject.getString("sort");
					//用户角色,1表示管理者,2表示使用者
					String isManager = dataObject.getString("isManager");
					//业务管路员ID
					String manager = dataObject.getString("manager");
					//业务管路员ID
					String project = dataObject.getString("project");
					dept.setId(id);
					dept.setDeptName(title);
					dept.setTenantId("000000");
					dept.setParentId(Long.parseLong(parentId));
					dept.setAncestors("0," + parentId);
					dept.setDeptCategory(3);
					dept.setFullName(title);
					dept.setSort(Integer.parseInt(sort));
					dept.setRemark(type);
					dept.setIsDeleted(0);
					switch (operate) {
						case "add":
							flag = deptService.save(dept);
							break;
						case "update":
							flag = deptService.updateById(dept);
							break;
						case "delete":
							flag = deptService.removeDept(id.toString());
							break;
						default:
							break;
					}
				}

			}
			return R.status(flag);
		}

		/**
		 * 退出
		 * @param ssoSessionKey
		 * @return
		 */
		@Override
		public String apiLogout(String ssoSessionKey) {
			JSONObject jsonObjectResult = new JSONObject();
			//请求接口地址
			String url = SsoLoginConstant.APILOGOUT_URL;
			Map<String, Object> paramMap = new HashMap<String, Object>();
			paramMap.put("ssoSessionKey", ssoSessionKey);
			try {
				String body = HttpUtil.createPost(url).form(paramMap).execute().body();
				if (StringUtils.isBlank(body)) {
					jsonObjectResult.put("code", 500);
					jsonObjectResult.put("msg", "请求失败");
					jsonObjectResult.put("data", "");
					jsonObjectResult.put("status", false);
					return jsonObjectResult.toJSONString();
				}
				JSONObject obj = JSONObject.parseObject(body);
				if (obj == null) {
					jsonObjectResult.put("code", 500);
					jsonObjectResult.put("msg", "请求失败");
					jsonObjectResult.put("data", "");
					jsonObjectResult.put("status", false);
					return jsonObjectResult.toJSONString();
				}
				String code = obj.get("code").toString();
				if ("200".equals(code)) {
					jsonObjectResult.put("code", 200);
					jsonObjectResult.put("msg", "请求成功");
					jsonObjectResult.put("data", obj.get("data"));
					jsonObjectResult.put("status", false);
					return jsonObjectResult.toJSONString();
				}else{
					jsonObjectResult.put("code", 500);
					jsonObjectResult.put("msg", "请求失败");
					jsonObjectResult.put("data", "");
					jsonObjectResult.put("status", false);
					return jsonObjectResult.toJSONString();
				}
			} catch (Exception e) {
				e.printStackTrace();
			}
			return jsonObjectResult.toJSONString();
		}


	}

先实现功能,在做优化~

  1. 控制器中的实现方法:
	package org.springblade.modules.system.controller;

import cn.hutool.http.HttpUtil;
import cn.hutool.json.JSONUtil;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.baomidou.mybatisplus.core.metadata.IPage;
import io.swagger.annotations.Api;
import lombok.AllArgsConstructor;
import org.apache.commons.lang.StringUtils;
import org.springblade.common.constant.TrainingSchemeConstant;
import org.springblade.core.mp.support.Condition;
import org.springblade.core.mp.support.Query;
import org.springblade.core.tool.api.R;
import org.springblade.core.tool.utils.Func;
import org.springblade.modules.system.entity.User;
import org.springblade.modules.system.entity.UserService;
import org.springblade.modules.system.service.ISsoLoginService;
import org.springblade.modules.system.service.impl.KnowledgeServiceImpl;
import org.springblade.modules.system.service.impl.SsoLoginServiceImpl;
import org.springblade.modules.system.service.impl.UserServiceImpl;
import org.springblade.modules.system.util.SsoLoginConstant;
import org.springblade.modules.system.util.TokenUtil;
import org.springblade.modules.system.vo.KnowledgeVO;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.client.RestTemplate;

import java.util.HashMap;
import java.util.Map;

@RestController
@AllArgsConstructor
@RequestMapping("api/sso")
@Api(value = "", tags = "接口")
public class ApiSsoController {

	private final SsoLoginServiceImpl ssoLoginService;

	/**
	 * 用户信息
	 */
	private final UserServiceImpl userService;

	//private final RabbitTemplate rabbitTemplate;


	/**
	 * 统一认证平台向第三方平台的接口发起请求。
	 * 新增、修改、删除平台用户信息,将用户数据上传到我方
	 *
	 * @param
	 */
	@PostMapping(value = "/pulluserinfo")
	public String pulluserinfo(@RequestBody String val) {
		JSONObject object = new JSONObject();
		R r = ssoLoginService.pullUserInfo(val);
		if (r.getCode() == 200) {
			object.put("msg", "操作成功");
			object.put("success", true);
			object.put("code", 200);
		} else {
			object.put("msg", "操作失败");
			object.put("success", false);
			object.put("code", 500);
		}
		return object.toJSONString();
	}

	/**
	 * 登录鉴权
	 * 
	 */
	@GetMapping("/check_login")
	public R checkLogin(String ssoSessionKey) {
		//拿到接口返回值
		String result = ssoLoginService.checkLogin(ssoSessionKey);
		JSONObject jsonObject = JSON.parseObject(result);
		Integer code = jsonObject.getInteger("code");
		if (code == 200) {
			//操作成功
			JSONObject jsonObjectData = jsonObject.getJSONObject("data");
			//拿到用户名和密码
			if (jsonObjectData != null) {
				//将用户名传给前台,前台拿着去登陆去
				String account = jsonObjectData.getString("username");
				return R.data(account);
			} else {
				return R.fail("未找到该用户");
			}
		} else {
			//操作失败
			return R.fail("未找到该用户");
		}
	}


	/**
	 * 查询平台用户信息
	 * 
	 */
	@GetMapping("/get_user")
	public String getUser(String projectKey) {

		return ssoLoginService.getUser(projectKey);
	}

	/**
	 * 查询平台组织机构
	 * 
	 */
	@GetMapping("/get_department")
	public String getDepartment(String projectKey) {
		return ssoLoginService.getDepartment(projectKey);
	}

	/**
	 * 退出时调用
	 * 注销统一认证平台的用户信息
	 */
	@GetMapping("/api_logout")
	public R apiLogout(String ssoSessionKey) {
		//拿到接口返回值
		String result = ssoLoginService.apiLogout(ssoSessionKey);
		JSONObject jsonObject = JSON.parseObject(result);
		Integer code = jsonObject.getInteger("code");
		if (code == 200) {
			return R.success("操作成功");
		} else {
			//操作失败
			return R.fail("接口请求出错");
		}
	}

}

整个后台的代码基本上就这些,基本上没啥难度,就是光操作的调用接口就可以了,主要麻烦点的是在前端,明天分享一下前端的实现。

单点登录, SSM框架公共模块 ├── zheng-admin -- 后台管理模板 ├── zheng-ui -- 前台thymeleaf模板[端口:1000] ├── zheng-config -- 配置中心[端口:1001] ├── zheng-upms -- 用户权限管理系统 | ├── zheng-upms-common -- upms系统公共模块 | ├── zheng-upms-dao -- 代码生成模块,无需开发 | ├── zheng-upms-client -- 集成upms依赖包,提供单点认证、授权、统一会话管理 | ├── zheng-upms-rpc-api -- rpc接口包 | ├── zheng-upms-rpc-service -- rpc服务提供者 | └── zheng-upms-server -- 用户权限系统及SSO服务端[端口:1111] ├── zheng-cms -- 内容管理系统 | ├── zheng-cms-common -- cms系统公共模块 | ├── zheng-cms-dao -- 代码生成模块,无需开发 | ├── zheng-cms-rpc-api -- rpc接口包 | ├── zheng-cms-rpc-service -- rpc服务提供者 | ├── zheng-cms-search -- 搜索服务[端口:2221] | ├── zheng-cms-admin -- 后台管理[端口:2222] | ├── zheng-cms-job -- 消息队列、任务调度等[端口:2223] | └── zheng-cms-web -- 网站前台[端口:2224] ├── zheng-pay -- 支付系统 | ├── zheng-pay-common -- pay系统公共模块 | ├── zheng-pay-dao -- 代码生成模块,无需开发 | ├── zheng-pay-rpc-api -- rpc接口包 | ├── zheng-pay-rpc-service -- rpc服务提供者 | ├── zheng-pay-sdk -- 开发工具包 | ├── zheng-pay-admin -- 后台管理[端口:3331] | └── zheng-pay-web -- 演示示例[端口:3332] ├── zheng-ucenter -- 用户系统(包括第三方登录) | ├── zheng-ucenter-common -- ucenter系统公共模块 | ├── zheng-ucenter-dao -- 代码生成模块,无需开发 | ├── zheng-ucenter-rpc-api -- rpc接口包 | ├── zheng-ucenter-rpc-service -- rpc服务提供者 | └── zheng-ucenter-web -- 网站前台[端口:4441] ├── zheng-wechat -- 微信系统 | ├── zheng-wechat-mp -- 微信公众号管理系统 | | ├── zheng-wechat-mp-dao -- 代码生成模块,无需开发 | | ├── zheng-wechat-mp-service -- 业务逻辑 | | └── zheng-wechat-mp-admin -- 后台管理[端口:5551] | └── zheng-ucenter-app -- 微信小程序后台 ├── zheng-api -- API接口总线系统 | ├── zheng-api-common -- api系统公共模块 | ├── zheng-api-rpc-api -- rpc接口包 | ├── zheng-api-rpc-service -- rpc服务提供者 | └── zheng-api-server -- api系统服务端[端口:6666] ├── zheng-oss -- 对象存储系统 | ├── zheng-oss-sdk -- 开发工具包 | ├── zheng-oss-web -- 前台接口[端口:7771] | └── zheng-oss-admin -- 后台管理[端口:7772] ├── zheng-shop -- 电子商务系统 ├── zheng-im -- 即时通讯系统 ├── zheng-oa -- 办公自动化系统 ├── zheng-eoms -- 运维系统 └── zheng-demo -- 示例模块(包含一些示例代码等) ├── zheng-demo-rpc-api -- rpc接口包 ├── zheng-demo-rpc-service -- rpc服务提供者 └── zheng-demo-web -- 演示示例[端口:8888] ``` ### 技术选型 #### 后端技术: 技术 | 名称 | 官网 ----|------|---- Spring Framework | 容器 | [http://projects.spring.io/spring-framework/](http://projects.spring.io/spring-framework/) SpringMVC | MVC框架 | [http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#mvc](http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#mvc) Apache Shiro | 安全框架 | [http://shiro.apache.org/](http://shiro.apache.org/) Spring session | 分布式Session管理 | [http://projects.spring.io/spring-session/](http://projects.spring.io/spring-session/) MyBatis | ORM框架 | [http://www.mybatis.org/mybatis-3/zh/index.html](http://www.mybatis.org/mybatis-3/zh/index.html) MyBatis Generator | 代码生成 | [http://www.mybatis.org/generator/index.html](http://www.mybatis.org/generator/index.html) PageHelper | MyBatis物理分页插件 | [http://git.oschina.net/free/Mybatis_PageHelper](http://git.oschina.net/free/Mybatis_PageHelper) Druid | 数据库连接池 | [https://github.com/alibaba/druid](https://github.com/alibaba/druid) FluentValidator | 校验框架 | [https://github.com/neoremind/fluent-validator](https://github.com/neoremind/fluent-validator) Thymeleaf | 模板引擎 | [http://www.thymeleaf.org/](http://www.thymeleaf.org/) Velocity | 模板引擎 | [http://velocity.apache.org/](http://velocity.apache.org/) ZooKeeper | 分布式协调服务 | [http://zookeeper.apache.org/](http://zookeeper.apache.org/) Dubbo | 分布式服务框架 | [http://dubbo.io/](http://dubbo.io/) TBSchedule & elastic-job | 分布式调度框架 | [https://github.com/dangdangdotcom/elastic-job](https://github.com/dangdangdotcom/elastic-job) Redis | 分布式缓存数据库 | [https://redis.io/](https://redis.io/) Solr & Elasticsearch | 分布式全文搜索引擎 | [http://lucene.apache.org/solr/](http://lucene.apache.org/solr/) [https://www.elastic.co/](https://www.elastic.co/) Quartz | 作业调度框架 | [http://www.quartz-scheduler.org/](http://www.quartz-scheduler.org/) Ehcache | 进程内缓存框架 | [http://www.ehcache.org/](http://www.ehcache.org/) ActiveMQ | 消息队列 | [http://activemq.apache.org/](http://activemq.apache.org/) JStorm | 实时流式计算框架 | [http://jstorm.io/](http://jstorm.io/) FastDFS | 分布式文件系统 | [https://github.com/happyfish100/fastdfs](https://github.com/happyfish100/fastdfs) Log4J | 日志组件 | [http://logging.apache.org/log4j/1.2/](http://logging.apache.org/log4j/1.2/) Swagger2 | 接口测试框架 | [http://swagger.io/](http://swagger.io/) sequence | 分布式高效ID生产 | [http://git.oschina.net/yu120/sequence](http://git.oschina.net/yu120/sequence) AliOSS & Qiniu & QcloudCOS | 云存储 | [https://www.aliyun.com/product/oss/](https://www.aliyun.com/product/oss/) [http://www.qiniu.com/](http://www.qiniu.com/) [https://www.qcloud.com/product/cos](https://www.qcloud.com/product/cos) Protobuf & json | 数据序列化 | [https://github.com/google/protobuf](https://github.com/google/protobuf) Jenkins | 持续集成工具 | [https://jenkins.io/index.html](https://jenkins.io/index.html) Maven | 项目构建管理 | [http://maven.apache.org/](http://maven.apache.org/) #### 前端技术: 技术 | 名称 | 官网 ----|------|---- jQuery | 函式库 | [http://jquery.com/](http://jquery.com/) Bootstrap | 前端框架 | [http://getbootstrap.com/](http://getbootstrap.com/) Bootstrap-table | Bootstrap数据表格 | [http://bootstrap-table.wenzhixin.net.cn/](http://bootstrap-table.wenzhixin.net.cn/) Font-awesome | 字体图标 | [http://fontawesome.io/](http://fontawesome.io/) material-design-iconic-font | 字体图标 | [https://github.com/zavoloklom/material-design-iconic-font](https://github.com/zavoloklom/material-design-iconic-font) Waves | 点击效果插件 | [https://github.com/fians/Waves](https://github.com/fians/Waves) zTree | 树插件 | [http://www.treejs.cn/v3/](http://www.treejs.cn/v3/) Select2 | 选择框插件 | [https://github.com/select2/select2](https://github.com/select2/select2) jquery-confirm | 弹出窗口插件 | [https://github.com/craftpip/jquery-confirm](https://github.com/craftpip/jquery-confirm) jQuery EasyUI | 基于jQuery的UI插件集合体 | [http://www.jeasyui.com](http://www.jeasyui.com) React | 界面构建框架 | [https://github.com/facebook/react](https://github.com/facebook/react) Editor.md | Markdown编辑器 | [https://github.com/pandao/editor.md](https://github.com/pandao/editor.md) zhengAdmin | 后台管理系统模板 | [https://github.com/shuzheng/zhengAdmin](https://github.com/shuzheng/zhengAdmin) autoMail | 邮箱地址自动补全插件 | [https://github.com/shuzheng/autoMail](https://github.com/shuzheng/autoMail) zheng.jprogress.js | 加载进度条插件 | [https://github.com/shuzheng/zheng.jprogress.js](https://github.com/shuzheng/zheng.jprogress.js) zheng.jtotop.js | 返回顶部插件 | [https://github.com/shuzheng/zheng.jtotop.js](https://github.com/shuzheng/zheng.jtotop.js) #### 架构图 ![架构图](project-bootstrap/architect.png) #### 模块依赖 ![模块依赖](project-bootstrap/project.png) #### 模块介绍 > zheng-common Spring+SpringMVC+Mybatis框架集成公共模块,包括公共配置、MybatisGenerator扩展插件、通用BaseService、工具类等。 > zheng-admin 基于bootstrap实现的响应式Material Design风格的通用后台管理系统,`zheng`项目所有后台系统都是使用该模块界面作为前端展示。 > zheng-ui 各个子系统前台thymeleaf模板,前端资源模块,使用nginx代理,实现动静分离。 > zheng-upms 本系统是基于RBAC授权和基于用户授权的细粒度权限控制通用平台,并提供单点登录、会话管理和日志管理。接入的系统可自由定义组织、角色、权限、资源等。用户权限=所拥有角色权限合集+用户加权限-用户减权限,优先级:用户减权限>用户加权限>角色权限 > zheng-oss 文件存储系统,提供四种方案: - **阿里云** OSS - **腾讯云** COS - **七牛云** - 本地分布式存储 ![阿里云OSS](project-bootstrap/aliyun-oss-post-callback.png) > zheng-api 服务网关,对外暴露统一规范的接口和包装响应结果,包括各个子系统的交互接口、对外开放接口、开发加密接口、接口文档等服务,可在该模块支持验签、鉴权、路由、限流、监控、容错、日志等功能。示例图: ![API网关](project-bootstrap/gateway_config.png) > zheng-cms 内容管理系统:支持多标签、多类目、强大评论的内容管理,有基本单页展示,菜单管理,系统设置等功能。 > zheng-pay - 一站式支付解决方案,统一下单接口,支持支付宝、微信、网银等多种支付方式。不涉及业务的纯粹的支付平台。 - 统一下单(统一下单接口、统一扫码)、订单管理、数据分析、财务报表、商户管理、渠道管理、对账系统、系统监控。 ![统一扫码支付](project-bootstrap/zheng-pay.png) > zheng-ucenter 通用用户管理系统, 实现最常用的用户注册、登录、资料管理、个人中心、第三方登录等基本需求,支持扩展二次开发。 > zheng-wechat-mp 微信公众号管理平台,除实现官网后台自动回复、菜单管理、素材管理用户管理、消息群发等基础功能外,还有二维码推广、营销活动、微网站、会员卡、优惠券等。 > zheng-wechat-app 微信小程序后台 ## 环境搭建(QQ群内有“zheng环境搭建和系统部署文档.doc”) #### 开发工具: - MySql: 数据库 - jetty: 开发服务器 - Tomcat: 应用服务器 - SVN|Git: 版本管理 - Nginx: 反向代理服务器 - Varnish: HTTP加速器 - IntelliJ IDEA: 开发IDE - PowerDesigner: 建模工具 - Navicat for MySQL: 数据库客户端 #### 开发环境: - Jdk7+ - Mysql5.5+ - Redis - Zookeeper - ActiveMQ - Dubbo-admin - Dubbo-monitor ### 工具安装 环境搭建和系统部署文档(作者:小兵,QQ群共享提供下载) ### 资源下载 - JDK7 [http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase7-521261.html](http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase7-521261.html "JDK7") - Maven [http://maven.apache.org/download.cgi](http://maven.apache.org/download.cgi "Maven") - Redis [https://redis.io/download](https://redis.io/download "Redis") - ActiveMQ [http://activemq.apache.org/download-archives.html](http://activemq.apache.org/download-archives.html "ActiveMQ") - ZooKeeper [http://www.apache.org/dyn/closer.cgi/zookeeper/](http://www.apache.org/dyn/closer.cgi/zookeeper/ "ZooKeeper") - Dubbo [http://dubbo.io/Download-zh.htm](http://dubbo.io/Download-zh.htm "Dubbo") - Elastic Stack [https://www.elastic.co/downloads](https://www.elastic.co/downloads "Elastic Stack") - Nginx [http://nginx.org/en/download.html](http://nginx.org/en/download.html "Nginx") - Jenkins [http://updates.jenkins-ci.org/download/war/](http://updates.jenkins-ci.org/download/war/ "Jenkins") - dubbo-admin-2.5.3 [http://download.csdn.net/detail/shuzheng5201314/9733652](http://download.csdn.net/detail/shuzheng5201314/9733652 "dubbo-admin-2.5.3") - dubbo-admin-2.5.4-SNAPSHOT-jdk8 [http://download.csdn.net/detail/shuzheng5201314/9733657](http://download.csdn.net/detail/shuzheng5201314/9733657 "dubbo-admin-2.5.4-SNAPSHOT-jdk8") - 更多资源请加QQ群 ## 开发指南: - 1、本机安装Jdk7、Mysql、Redis、Zookeeper、ActiveMQ并**启动相关服务**,使用默认配置默认端口即可 - 2、克隆源代码到本地并打开,**推荐使用IntelliJ IDEA**,本地编译并安装到本地maven仓库 ### 修改本地Host - 127.0.0.1 ui.zhangshuzheng.cn - 127.0.0.1 upms.zhangshuzheng.cn - 127.0.0.1 cms.zhangshuzheng.cn - 127.0.0.1 pay.zhangshuzheng.cn - 127.0.0.1 ucenter.zhangshuzheng.cn - 127.0.0.1 wechat.zhangshuzheng.cn - 127.0.0.1 api.zhangshuzheng.cn - 127.0.0.1 oss.zhangshuzheng.cn - 127.0.0.1 config.zhangshuzheng.cn - 127.0.0.1 zkserver - 127.0.0.1 rdserver - 127.0.0.1 dbserver - 127.0.0.1 mqserver ### 编译流程 maven编译安装zheng/pom.xml文件即可 ### 启动顺序(后台) > 准备工作 - 新建zheng数据库,导入project-datamodel文件夹下的zheng.sql - 修改各dao模块和rpc-service模块的redis.properties、jdbc.properties、generator.properties数据库连接等配置信息,其中master.redis.password、master.jdbc.password、slave.jdbc.password、generator.jdbc.password密码值使用了AES加密,请使用com.zheng.common.util.AESUtil工具类修改这些值 - 启动Zookeeper、Redis、ActiveMQ、Nginx(配置文件参考project-tools/nginx下的*.conf文件) > **zheng-upms** - 首先启动 zheng-upms-rpc-service(直接运行src目录下的ZhengUpmsRpcServiceApplication#main方法启动) => zheng-upms-server(jetty),然后按需启动对应子系统xxx的zheng-xxx-rpc-service(main方法) => zheng-xxx-webapp(jetty) ![启动演示](project-bootstrap/start.png) - 访问 [http://upms.zhangshuzheng.cn:1111/](http://upms.zhangshuzheng.cn:1111/ "统一后台地址"),子系统菜单已经配置到zheng-upms权限中,不用直接访问子系统,默认帐号密码:admin/123456 - 登录成功后,可在右上角切换已注册系统访问 > **zheng-cms** - zheng-cms-admin:启动ActiveMQ-启动 => 启动zheng-rpc-service => 启动zheng-cms-admin - zheng-cms-web:启动nginx代理zheng-ui静态资源,配置文件可参考 [nginx.conf](http://git.oschina.net/shuzheng/zheng/attach_files) > **zheng-oss** - 首先启动zheng-oss-web服务 - 开发阶段,如果zheng-oss-web没有公网域名,推荐使用`ngrok`内网穿透工具,为开发环境提供公网域名,实现上传回调 - 启动nginx代理zheng-ui静态资源 ### 开发演示(QQ群内有“zheng十分钟视频:从检出到启动.wmv”) - 创建数据表(建议使用PowerDesigner) - 直接运行对应项目dao模块中的generator.main(),可自动生成单表的CRUD功能和对应的model、example、mapper、service代码 - 生成的model和example均已实现Serializable接口,支持分布式 - 已包含抽象类BaseServiceImpl,只需要继承抽象类并传入泛型参数,即可默认实现mapper接口所有方法,特殊需求直接扩展即可 - BaseServiceImpl默认已实现四种根据条件分页接口 - selectByExampleWithBLOBsForStartPage() - selectByExampleForStartPage() - selectByExampleWithBLOBsForOffsetPage() - selectByExampleForOffsetPage() - BaseServiceImpl方法根据读写操作自动切换主从数据源,继承的扩展接口,可手动通过`DynamicDataSource.setDataSource(DataSourceEnum.XXX.getName())`指定数据源 - 启动流程:优先rcp-service服务提供者,再启动其他webapp - 扩展流程:可扩展和拆分rpc-api和rpc-service模块,可按微服务拆分或场景拆分 ### 部署方式(QQ群内有“zheng十分钟视频:从打包到linux服务器部署.wmv”) - war包项目:使用tomcat等web容器启动 - rpc-service服务提供者jar包:将打包后的zheng-xxx-rpc-service-assembly.tar.gz文件解压,使用bin目录的管理脚本运行即可,支持优雅停机。 ### 框架规范约定 约定优于配置(convention over configuration),此框架约定了很多编程规范,下面一一列举: ``` - service类,需要在叫名`service`的包下,并以`Service`结尾,如`CmsArticleServiceImpl` - controller类,需要在以`controller`结尾的包下,类名以Controller结尾,如`CmsArticleController.java`,并继承`BaseController` - spring task类,需要在叫名`task`的包下,并以`Task`结尾,如`TestTask.java` - mapper.xml,需要在名叫`mapper`的包下,并以`Mapper.xml`结尾,如`CmsArticleMapper.xml` - mapper接口,需要在名叫`mapper`的包下,并以`Mapper`结尾,如`CmsArticleMapper.java` - model实体类,需要在名叫`model`的包下,命名规则为数据表转驼峰规则,如`CmsArticle.java` - spring配置文件,命名规则为`applicationContext-*.xml` - 类名:首字母大写驼峰规则;方法名:首字母小写驼峰规则;常量:全大写;变量:首字母小写驼峰规则,尽量非缩写 - springmvc配置加到对应模块的`springMVC-servlet.xml`文件里 - 配置文件放到`src/main/resources`目录下 - 静态资源文件放到`src/main/webapp/resources`目录下 - jsp文件,需要在`/WEB-INF/jsp`目录下 - `RequestMapping`和返回物理试图路径的url尽量写全路径,如:`@RequestMapping("/manage")`、`return "/manage/index"` - `RequestMapping`指定method - 模块命名为`项目`-`子项目`-`业务`,如`zheng-cms-admin` - 数据表命名为:`子系统`_`表`,如`cms_article` - 更多规范,参考[[阿里巴巴Java开发手册] http://git.oschina.net/shuzheng/zheng/attach_files ``` ## 演示地址 演示地址: [http://upms.zhangshuzheng.cn/](http://47.93.195.63/zheng-upms-server/sso/login?backurl=http://47.93.195.63/zheng-upms-server/manage/index "演示地址") ### 预览图 ![idea](project-bootstrap/idea.png) ![login](project-bootstrap/zheng-login.png) ![upms](project-bootstrap/zheng-upms.png) ![cms](project-bootstrap/zheng-cms.png) ![swagger](project-bootstrap/api.png) ### 数据模型 ![数据库模型](project-datamodel/zheng.png) ### 拓扑图 ![拓扑图](project-bootstrap/distributedSystem.png) ### 开发进度 ![开发进度](project-bootstrap/progress.png) ### 参与开发 首先谢谢大家支持,如果你希望参与开发,欢迎通过[Github](https://github.com/shuzheng/zheng "Github")上fork本项目,并Pull Request您的commit。 ### 常见问题 - Eclipse下,dubbo找不到dubbo.xsd报错,不影响使用,如果要解决,可参考 [http://blog.csdn.net/gjldwz/article/details/50555922](http://blog.csdn.net/gjldwz/article/details/50555922) - 报zheng-xxx.jar包找不到,请按照文档编译顺序,将源代码编译并安装到本地maven仓库 - zheng-cms-admin启动卡住:因为没有启动activemq - zheng-upms-server访问报session不存在:因为没有启动redis服务 - 界面没有样式:因为zheng-admin没有编译安装到本地仓库 ## 附件 ### 优秀文章和博客 - [创业互联网公司如何搭建自己的技术框架](http://shuzheng5201314.iteye.com/blog/2330151 "创业互联网公司如何搭建自己的技术框架") - [微服务实战](https://segmentfault.com/a/1190000004634172 "微服务实战") - [单点登录原理与简单实现](http://shuzheng5201314.iteye.com/blog/2343910 "单点登录原理与简单实现") - [ITeye论坛关于权限控制的讨论](http://www.iteye.com/magazines/82 "ITeye论坛关于权限控制的讨论") - [RBAC新解:基于资源的权限管理(Resource-Based Access Control)](http://globeeip.iteye.com/blog/1236167 "RBAC新解:基于资源的权限管理(Resource-Based Access Control)") - [网站架构经验随笔](http://jinnianshilongnian.iteye.com/blog/2289904 "网站架构经验随笔") - [支付系统架构](http://shuzheng5201314.iteye.com/blog/2355431 "支付系统架构") - [Spring整合JMS](http://elim.iteye.com/blog/1893038 "Spring整合JMS") - [跟我学Shiro目录贴](http://jinnianshilongnian.iteye.com/blog/2018398 "跟我学Shiro目录贴") - [跟我学SpringMVC目录汇总贴](http://jinnianshilongnian.iteye.com/blog/1752171 "跟我学SpringMVC目录汇总贴") - [跟我学spring3 目录贴](http://jinnianshilongnian.iteye.com/blog/1482071 "跟我学spring3 目录贴") - [跟我学OpenResty(Nginx+Lua)开发目录贴](http://jinnianshilongnian.iteye.com/blog/2190344 "跟我学OpenResty(Nginx+Lua)开发目录贴") - [Redis中文网](http://www.redis.net.cn/ "Redis中文网") - [读懂Redis并配置主从集群及高可用部署](http://mp.weixin.qq.com/s?__biz=MzIxNTYzOTQ0Ng==&mid=2247483668&idx=1&sn=cd31574877d38cf7ff9c047b86c9bf23&chksm=979475eda0e3fcfb6b5006bcd19c5a838eca9e369252847dbdf97820bf418201dd75c1dadda3&mpshare=1&scene=23&srcid=0117KUiiITwi2ETRan16xRVg#rd "读懂Redis并配置主从集群及高可用部署") - [Redis哨兵-实现Redis高可用](http://redis.majunwei.com/topics/sentinel.html "Redis哨兵-实现Redis高可用") - [ELK(ElasticSearch, Logstash, Kibana)搭建实时日志分析平台](http://www.open-open.com/lib/view/open1451801542042.html "ELK(ElasticSearch, Logstash, Kibana)搭建实时日志分析平台") - [Nginx基本功能极速入门](http://xxgblog.com/2015/05/17/nginx-start/ "Nginx基本功能极速入门") - [mybatis-genarator 自定义插件](https://my.oschina.net/alexgaoyh/blog/702791 "mybatis-genarator 自定义插件") - [Elasticsearch权威指南(中文版)](https://es.xiaoleilu.com/510_Deployment/20_hardware.html "Elasticsearch权威指南(中文版)") - [springMVC对简单对象、Set、List、Map的数据绑定和常见问题.](http://blog.csdn.net/z_dendy/article/details/12648641 "springMVC对简单对象、Set、List、Map的数据绑定和常见问题.") - [如何细粒度地控制你的MyBatis二级缓存](http://blog.csdn.net/luanlouis/article/details/41800511 "如何细粒度地控制你的MyBatis二级缓存") - [做个男人,做个成熟的男人,做个有城府的男人](http://shuzheng5201314.iteye.com/blog/1387820 "做个男人,做个成熟的男人,做个有城府的男人") ### 在线小工具 - [在线Cron表达式生成器](http://cron.qqe2.com/ "在线Cron表达式生成器") - [在线工具 - 程序员的工具箱](http://tool.lu/ "在线工具 - 程序员的工具箱") ### 在线文档 - [JDK7英文文档](http://tool.oschina.net/apidocs/apidoc?api=jdk_7u4 "JDK7英文文档") - [Spring4.x文档](http://spring.oschina.mopaas.com/ "Spring4.x文档") - [Mybatis3官网](http://www.mybatis.org/mybatis-3/zh/index.html "Mybatis3官网") - [Dubbo官网](http://dubbo.io/ "Dubbo官网") - [Nginx中文文档](http://tool.oschina.net/apidocs/apidoc?api=nginx-zh "Nginx中文文档") - [Freemarker在线手册](http://freemarker.foofun.cn/ "Freemarker在线中文手册") - [Velocity在线手册](http://velocity.apache.org/engine/devel/developer-guide.html "Velocity在线手册") - [Bootstrap在线手册](http://www.bootcss.com/ "Bootstrap在线手册") - [Git官网中文文档](https://git-scm.com/book/zh/v2 "Git官网中文文档") - [Thymeleaf](http://www.thymeleaf.org/doc/tutorials/3.0/thymeleafspring.html "Thymeleaf") ## 许可证 [MIT](LICENSE "MIT")
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

穆雄雄

哎,貌似还没开张来着呢~

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值