6242bab855 | ||
---|---|---|
project-bootstrap | ||
project-datamodel | ||
zheng-api | ||
zheng-cms | ||
zheng-common | ||
zheng-eoms | ||
zheng-im | ||
zheng-oa | ||
zheng-oss | ||
zheng-pay | ||
zheng-shop | ||
zheng-ucenter | ||
zheng-ui | ||
zheng-upms | ||
zheng-wechat | ||
.gitignore | ||
README.md |
README.md
zheng
交流QQ群:133107819 (群内含各种工具和文档下载)
前言
zheng
项目创建于2016年10月4日,正在慢慢成长中,目的不仅仅是一个开发架构,而是努力打造一套从 前端UI - 基础框架 - 分布式架构 - 开源项目 - 持续集成 - 自动化部署 - 系统监测 - 无缝升级 的全方位J2EE企业级开发解决方案。
项目介绍
基于Spring+SpringMVC+Mybatis分布式敏捷开发系统架构:内容管理系统(门户、博客、论坛、问答等)、统一支付中心(微信、支付宝、在线网银等)、用户权限管理系统(RBAC细粒度用户权限、统一后台、单点登录、会话管理)、微信管理系统、第三方登录系统、会员系统、存储系统等,努力为中小型企业打造全方位J2EE企业级开发解决方案。
组织结构
zheng
├── zheng-common -- SSM框架公共模块
├── zheng-ui -- 后台管理系统UI模板(基于bootstrap实现的响应式Material Design风格的通用后台管理系统模板)
├── zheng-upms -- 用户权限管理系统(网关)
| ├── zheng-upms-common -- upms系统公共模块
| ├── zheng-upms-dao -- MyBatisGenerator代码生成模块,无需开发
| ├── 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 -- MyBatisGenerator代码生成模块,无需开发
| ├── 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-dao -- MyBatisGenerator代码生成模块,无需开发
| ├── zheng-pay-service -- 业务逻辑
| ├── zheng-pay-sdk -- 开发工具包
| ├── zheng-pay-admin -- 后台管理[端口:3331]
| └── zheng-pay-web -- 演示示例[端口:3332]
├── zheng-ucenter -- 用户系统(包括第三方登录)
| ├── zheng-ucenter-dao -- MyBatisGenerator代码生成模块,无需开发
| ├── zheng-ucenter-service -- 业务逻辑
| └── zheng-ucenter-home -- 网站前台[端口:4441]
├── zheng-wechat -- 微信系统
| ├── zheng-wechat-mp -- 微信公众号管理系统
| | ├── zheng-wechat-mp-dao -- MyBatisGenerator代码生成模块,无需开发
| | ├── 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-shop -- 电子商务系统
├── zheng-im -- 即时通讯系统
├── zheng-oa -- 办公自动化系统
├── zheng-eoms -- 运维系统
└── zheng-oss -- 对象存储系统
├── zheng-oss-sdk -- 开发工具包
└── zheng-oss-web -- 管理界面[端口:7771]
技术选型
后端技术:
- Spring Framework
- SpringMVC: MVC框架
- Spring secutity|Apache Shiro: 安全框架
- Spring session: 分布式Session管理
- MyBatis: ORM框架
- MyBatis Generator: 代码生成
- Druid: 数据库连接池
- FluentValidator: 校验框架 https://github.com/neoremind/fluent-validator
- Jsp|Velocity|Thymeleaf: 模板引擎
- ZooKeeper: 分布式协调服务
- Dubbo: 分布式服务框架
- TBSchedule|elastic-job: 分布式调度框架
- Redis: 分布式缓存数据库
- Solr|Elasticsearch: 分布式全文搜索引擎
- Quartz: 作业调度框架
- Ehcache: 进程内缓存框架
- ActiveMQ: 消息队列
- JStorm: 实时流式计算框架
- FastDFS: 分布式文件系统
- Log4J: 日志管理
- Swagger2: 接口测试框架
- sequence: 分布式高效ID生产 http://git.oschina.net/yu120/sequence
- AliOSS|Qiniu|QcloudCOS: 云存储
- Protobuf|json: 数据传输
- Jenkins: 持续集成工具
- Maven|Gradle: 项目构建管理
前端技术:
- jQuery
- Bootstrap
- jQuery EasyUI
- AngularJs
- zhengAdmin 基于bootstrap实现的响应式Material Design风格的通用后台管理系统
- autoMail 邮箱地址自动补全插件
- zheng.jprogress.js 一款模仿youtube加载进度条插件
- zheng.jtotop.js 返回顶部插件(可以任意速度滑动到指定任意位置)
模块依赖
模块介绍
zheng-common
Spring+SpringMVC+Mybatis框架集成公共模块,包括公共配置、MybatisGenerator扩展插件、通用BaseService、工具类等。
zheng-ui
基于bootstrap实现的响应式Material Design风格的通用后台管理系统,zheng
项目所有系统都是使用该模块界面作为前端展示。
zheng-upms
本系统是基于RBAC授权和基于用户授权的细粒度权限控制通用平台,并提供单点登录、会话管理和日志管理。接入的系统可自由定义组织、角色、权限、资源等。
系统功能概述:
- 系统组织管理:系统和组织增加、删除、修改、查询功能。
- 用户角色管理:用户和角色增加、删除、修改、查询功能。
- 资源权限管理:资源和权限增加、删除、修改、查询功能。
- 权限分配管理:提供给角色和用户的权限增加、删除、修改、查询功能。
- 单点登录(SSO):提供统一用户单点登录认证、用户鉴权功能。
- 用户会话管理:提供分布式用户会话管理
- 操作日志管理:提供记录用户登录、操作等日志。
zheng-oss
文件存储系统,提供四种方案:
- 阿里云 OSS
- 腾讯云 COS
- 七牛云
- 本地分布式存储
zheng-api
接口总线系统,对外暴露统一规范的接口,包括各个子系统的交互接口、对外开放接口、开发加密接口、接口文档等服务,示例图:
zheng-cms
内容管理系统:支持多标签、多类目、强大评论的内容管理,有基本单页展示,菜单管理,系统设置等功能。
zheng-pay
-
一站式支付解决方案,统一下单接口,支持支付宝、微信、网银等多种支付方式。不涉及业务的纯粹的支付平台。
-
统一下单(统一下单接口、统一扫码)、订单管理、数据分析、财务报表、商户管理、渠道管理、对账系统、系统监控。
zheng-ucenter
通用用户管理系统, 实现最常用的用户注册、登录、资料管理、个人中心、第三方登录等基本需求,支持扩展二次开发。
zheng-wechat-mp
微信公众号管理平台,除实现官网后台自动回复、菜单管理、素材管理、用户管理、消息群发等基础功能外,还有二维码推广、营销活动、微网站、会员卡、优惠券等。
zheng-ucenter-app
微信小程序后台
zheng-shop
电子商务系统
zheng-im
即时通讯系统
zheng-oa
办公自动化系统
zheng-eoms
运维系统
环境搭建
开发工具:
- MySql: 数据库
- jetty: 开发服务器
- Tomcat: 应用服务器
- SVN|Git: 版本管理
- Nginx: 反向代理服务器
- Varnish: HTTP加速器
- IntelliJ IDEA: 开发IDE
- PowerDesigner: 建模工具
- Navicat for MySQL: 数据库客户端
开发环境:
- Jdk7
- Mysql5.5
- Redis
- Zookeeper
- ActiveMQ
- Dubbo-admin
工具安装
资源下载
- JDK7 http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase7-521261.html
- Maven http://maven.apache.org/download.cgi
- Redis https://redis.io/download
- ActiveMQ http://activemq.apache.org/download-archives.html
- ZooKeeper http://www.apache.org/dyn/closer.cgi/zookeeper/
- Dubbo http://dubbo.io/Download-zh.htm
- Elastic Stack https://www.elastic.co/downloads
- Jenkins http://updates.jenkins-ci.org/download/war/
- dubbo-admin-2.5.3 http://download.csdn.net/detail/shuzheng5201314/9733652
- dubbo-admin-2.5.4-SNAPSHOT-jdk8 http://download.csdn.net/detail/shuzheng5201314/9733657
- 更多资源请加QQ群
开发指南:
- 1、本机安装Jdk7、Mysql、Redis、Zookeeper、ActiveMQ并启动相关服务,使用默认配置默认端口即可
- 2、克隆源代码到本地并打开,推荐使用IntelliJ IDEA,本地编译并安装到本地maven仓库
修改本地Host
- 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
编译流程
zheng-ui、zheng-common => zheng-oss、zheng-api => zheng-upms => 其他
启动顺序
-
新建zheng数据库,导入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工具类修改这些值
-
启动 zheng-upms-rpc-service => zheng-upms-server => zheng-xxx-rpc-service => zheng-xxx-webapp
-
访问 统一后台地址 http://upms.zhangshuzheng.cn:1111/ ,默认帐号密码:admin/123456
-
登录成功后,可在右上角切换已注册系统访问
开发演示
-
创建数据表(建议使用PowerDesigner)
-
直接运行对应项目dao模块中的generator.main(),可自动生成单表的CRUD功能和对应的model、example、mapper、service代码
- 生成的model和example均已实现Serializable接口,支持分布式
- 生成的mapper.xml的selectByExample方法自动包含分页参数offset和limit
- 已包含抽象类BaseServiceImpl,只需要继承抽象类并传入泛型参数,即可默认实现mapper接口所有方法,特殊需求直接扩展即可
- BaseServiceImpl方法根据读写操作自动切换主从数据源,继承的扩展接口,可手动通过
DynamicDataSource.setDataSource(DataSourceEnum.XXX.getName())
指定数据源
-
启动流程:优先rcp-service服务提供者,再启动其他webapp
-
扩展流程:可扩展和拆分rpc-api和rpc-service模块,可按微服务拆分或场景拆分
框架规范约定
约定优于配置(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://www.zhangshuzheng.cn/zhengAdmin