前言
zheng项目不仅仅是一个开发架构,而是努力打造一套从 前端模板 - 基础框架 - 分布式架构 - 开源项目 - 持续集成 - 自动化部署 - 系统监测 - 无缝升级 的全方位J2EE企业级开发解决方案。
项目介绍
基于Spring+SpringMVC+Mybatis分布式敏捷开发系统架构,提供整套公共微服务服务模块:内容管理、支付中心、用户管理(包括第三方)、微信平台、存储系统、配置中心、日志分析、任务和通知等,支持服务治理、监控和追踪,努力为中小型企业打造全方位J2EE企业级开发解决方案。
组织结构
zheng
├── zheng-common -- 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-message -- 实时通知系统
| ├── zheng-message-sdk -- 开发工具包
| ├── zheng-message-server -- 服务端[端口:8881,SocketIO端口:8882]
| └── zheng-message-client -- 客户端
├── zheng-shop -- 电子商务系统
└── zheng-demo -- 示例模块(包含一些示例代码等)
├── zheng-demo-rpc-api -- rpc接口包
├── zheng-demo-rpc-service -- rpc服务提供者
└── zheng-demo-web -- 演示示例[端口:9999]
技术选型
后端技术:
技术名称官网Spring Framework容器http://projects.spring.io/spring-framework/SpringMVCMVC框架http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#mvcApache Shiro安全框架http://shiro.apache.org/Spring session分布式Session管理http://projects.spring.io/spring-session/MyBatisORM框架http://www.mybatis.org/mybatis-3/zh/index.htmlMyBatis Generator代码生成http://www.mybatis.org/generator/index.htmlPageHelperMyBatis物理分页插件http://git.oschina.net/free/Mybatis_PageHelperDruid数据库连接池https://github.com/alibaba/druidFluentValidator校验框架https://github.com/neoremind/fluent-validatorThymeleaf模板引擎http://www.thymeleaf.org/Velocity模板引擎http://velocity.apache.org/ZooKeeper分布式协调服务http://zookeeper.apache.org/Dubbo分布式服务框架http://dubbo.io/TBSchedule & elastic-job分布式调度框架https://github.com/dangdangdotcom/elastic-jobRedis分布式缓存数据库https://redis.io/Solr & Elasticsearch分布式全文搜索引擎http://lucene.apache.org/solr/ https://www.elastic.co/Quartz作业调度框架http://www.quartz-scheduler.org/Ehcache进程内缓存框架http://www.ehcache.org/ActiveMQ消息队列http://activemq.apache.org/JStorm实时流式计算框架http://jstorm.io/FastDFS分布式文件系统https://github.com/happyfish100/fastdfsLog4J日志组件http://logging.apache.org/log4j/1.2/Swagger2接口测试框架http://swagger.io/sequence分布式高效ID生产http://git.oschina.net/yu120/sequenceAliOSS & Qiniu & QcloudCOS云存储https://www.aliyun.com/product/oss/ http://www.qiniu.com/ https://www.qcloud.com/product/cosProtobuf & json数据序列化https://github.com/google/protobufJenkins持续集成工具https://jenkins.io/index.htmlMaven项目构建管理http://maven.apache.org/Netty-socketio实时推送https://github.com/mrniko/netty-socketio
前端技术:
技术名称官网jQuery函式库http://jquery.com/Bootstrap前端框架http://getbootstrap.com/Bootstrap-tableBootstrap数据表格http://bootstrap-table.wenzhixin.net.cn/Font-awesome字体图标http://fontawesome.io/material-design-iconic-font字体图标https://github.com/zavoloklom/material-design-iconic-fontWaves点击效果插件https://github.com/fians/WaveszTree树插件http://www.treejs.cn/v3/Select2选择框插件https://github.com/select2/select2jquery-confirm弹出窗口插件https://github.com/craftpip/jquery-confirmjQuery EasyUI基于jQuery的UI插件集合体http://www.jeasyui.comReact界面构建框架https://github.com/facebook/reactEditor.mdMarkdown编辑器https://github.com/pandao/editor.mdzhengAdmin后台管理系统模板https://github.com/shuzheng/zhengAdminautoMail邮箱地址自动补全插件https://github.com/shuzheng/autoMailzheng.jprogress.js加载进度条插件https://github.com/shuzheng/zheng.jprogress.jszheng.jtotop.js返回顶部插件https://github.com/shuzheng/zheng.jtotop.jssocket.io.jsSocketIO插件https://socket.io/
架构图
模块依赖
模块介绍
zheng-common
Spring+SpringMVC+Mybatis框架集成公共模块,包括公共配置、MybatisGenerator扩展插件、通用BaseService、工具类等。
zheng-admin
基于bootstrap实现的响应式Material Design风格的通用后台管理系统,zheng项目所有后台系统都是使用该模块界面作为前端展示。
zheng-ui
各个子系统前台thymeleaf模板,前端资源模块,使用nginx代理,实现动静分离。
zheng-upms
本系统是基于RBAC授权和基于用户授权的细粒度权限控制通用平台,并提供单点登录、会话管理和日志管理。接入的系统可自由定义组织、角色、权限、资源等。用户权限=所拥有角色权限合集+用户加权限-用户减权限,优先级:用户减权限>用户加权限>角色权限
zheng-oss
文件存储系统,提供四种方案:
zheng-api
服务网关,对外暴露统一规范的接口和包装响应结果,包括各个子系统的交互接口、对外开放接口、开发加密接口、接口文档等服务,可在该模块支持验签、鉴权、路由、限流、监控、容错、日志等功能。示例图:
zheng-cms
内容管理系统:支持多标签、多类目、强大评论的内容管理,有基本单页展示,菜单管理,系统设置等功能。
zheng-pay
zheng-ucenter
通用用户管理系统, 实现最常用的用户注册、登录、资料管理、个人中心、第三方登录等基本需求,支持扩展二次开发。
zheng-wechat-mp
微信公众号管理平台,除实现官网后台自动回复、菜单管理、素材管理、用户管理、消息群发等基础功能外,还有二维码推广、营销活动、微网站、会员卡、优惠券等。
zheng-wechat-app
微信小程序后台
zheng-message
基于Netty实现SocketIO的实时推送系统。支持命名空间、二进制数据、SSL、ACK等功能。
环境搭建(QQ群内有“zheng环境搭建和系统部署文档.doc”)
开发工具:
开发环境:
工具安装
环境搭建和系统部署文档(作者:小兵,QQ群共享提供下载)
资源下载
开发指南:
修改本地Host
编译流程
maven编译安装zheng/pom.xml文件即可
启动顺序(后台)
准备工作
zheng-upms
zheng-cms
zheng-oss
开发演示(QQ群内有“zheng十分钟视频:从检出到启动.wmv”)
部署方式(QQ群内有“zheng十分钟视频:从打包到linux服务器部署.wmv”)
框架规范约定
约定优于配置(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/
预览图
数据模型
拓扑图
开发进度
git地址:https://gitee.com/shuzheng/zheng
留言与评论(共有 0 条评论) |