Go to file
shuzheng 916e8bd328 更新pay依赖包 2017-03-30 12:34:50 +08:00
project-bootstrap 更新进度图 2017-03-29 22:25:16 +08:00
project-datamodel 更新数据模型 2017-03-29 22:01:33 +08:00
zheng-admin 拆分静态资源zheng-admin(后台管理模板),zheng-ui(前台thymeleaf模板) 2017-03-27 00:34:35 +08:00
zheng-api 完成pay-rpc-service配置 2017-03-29 23:41:21 +08:00
zheng-cms 完成pay-rpc-service配置 2017-03-29 23:41:21 +08:00
zheng-common 更新springContextUtil工具类 2017-03-29 00:30:30 +08:00
zheng-demo 拆分静态资源zheng-admin(后台管理模板),zheng-ui(前台thymeleaf模板) 2017-03-27 00:34:35 +08:00
zheng-eoms 增加运维系统 2017-02-08 23:43:47 +08:00
zheng-im 增加子项目README.md 2017-02-08 23:35:25 +08:00
zheng-oa 增加zheng-oa 2017-02-08 23:52:45 +08:00
zheng-oss 修复错误页面报错的问题 2017-03-27 00:35:24 +08:00
zheng-pay 更新pay依赖包 2017-03-30 12:34:50 +08:00
zheng-shop 增加zheng-shop 2017-02-08 23:52:58 +08:00
zheng-ucenter 修复错误页面报错的问题 2017-03-27 00:35:24 +08:00
zheng-ui 拆分静态资源zheng-admin(后台管理模板),zheng-ui(前台thymeleaf模板) 2017-03-27 00:34:35 +08:00
zheng-upms 增加简单搜索功能 2017-03-28 22:20:33 +08:00
zheng-wechat 修复错误页面报错的问题 2017-03-27 00:35:24 +08:00
.gitignore 拆分静态资源zheng-admin(后台管理模板),zheng-ui(前台thymeleaf模板) 2017-03-27 00:34:35 +08:00
LICENSE add LICENSE 2017-03-08 23:51:52 +08:00
README.md 更新文档 2017-03-29 23:45:01 +08:00

README.md

zheng

License PRs Welcome GitHub stars GitHub forks

交流QQ群133107819🈵、284280411🈵、528049386🈵、305155242♨️(群内含各种工具和文档下载)

前言

  zheng项目创建于2016年10月4日正在慢慢成长中目的不仅仅是一个开发架构而是努力打造一套从 前端模板 - 基础框架 - 分布式架构 - 开源项目 - 持续集成 - 自动化部署 - 系统监测 - 无缝升级 的全方位J2EE企业级开发解决方案。

项目介绍

  基于Spring+SpringMVC+Mybatis分布式敏捷开发系统架构提供整套公共微服务服务模块内容管理、支付中心、用户管理包括第三方、微信平台、存储系统、配置中心、日志分析、任务和通知等支持服务治理、监控和追踪努力为中小型企业打造全方位J2EE企业级开发解决方案。

组织结构

zheng
├── zheng-common -- SSM框架公共模块
├── zheng-admin -- 后台管理模板
├── zheng-ui -- 前台thymeleaf模板[端口:1000]
├── 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-dao -- 代码生成模块,无需开发
|    ├── zheng-ucenter-service -- 业务逻辑
|    └── zheng-ucenter-home -- 网站前台[端口: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-shop -- 电子商务系统
├── zheng-im -- 即时通讯系统
├── zheng-oa -- 办公自动化系统
├── zheng-eoms -- 运维系统
└── zheng-demo -- 示例模块(包含一些示例代码等)

技术选型

后端技术:

前端技术:

架构图

架构图

模块依赖

模块依赖

模块介绍

zheng-common

Spring+SpringMVC+Mybatis框架集成公共模块包括公共配置、MybatisGenerator扩展插件、通用BaseService、工具类等。

zheng-admin

基于bootstrap实现的响应式Material Design风格的通用后台管理系统zheng项目所有后台系统都是使用该模块界面作为前端展示。

zheng-ui

各个子系统前台thymeleaf模板前端资源模块使用nginx代理实现动静分离。

zheng-upms

本系统是基于RBAC授权和基于用户授权的细粒度权限控制通用平台并提供单点登录、会话管理和日志管理。接入的系统可自由定义组织、角色、权限、资源等。

zheng-oss

文件存储系统,提供四种方案:

  • 阿里云 OSS
  • 腾讯云 COS
  • 七牛云
  • 本地分布式存储

zheng-api

接口总线系统,对外暴露统一规范的接口,包括各个子系统的交互接口、对外开放接口、开发加密接口、接口文档等服务,示例图:

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

工具安装

环境搭建和系统部署文档(作者:小兵)

资源下载

开发指南:

  • 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

编译流程

zheng-admin、zheng-common => zheng-upms => 其他

启动顺序(后台)

- 新建zheng数据库导入project-bootstrap文件夹下的zheng-xxx.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(直接运行src目录下的ZhengUpmsRpcServiceApplication#main方法启动) => zheng-upms-server(jetty)然后按需启动对应子系统xxx的zheng-xxx-rpc-service(main方法) => zheng-xxx-webapp(jetty)

rpc-service启动演示 web启动演示

- 访问 [统一后台地址 http://upms.zhangshuzheng.cn:1111/]子系统菜单已经配置到zheng-upms权限中不用直接访问子系统默认帐号密码admin/123456

- 登录成功后,可在右上角切换已注册系统访问

启动顺序(前台)

- 启动nginx代理zheng-ui静态资源配置文件可参考 [nginx.conf](http://git.oschina.net/shuzheng/zheng/attach_files)

- 启动前台系统应用服务器

开发演示

- 创建数据表建议使用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://git.oschina.net/shuzheng/zheng/attach_files "Alibaba Java Development Manual.pdf")]

演示地址

演示地址: http://www.zhangshuzheng.cn/zhengAdmin

预览图

idea login upms cms swagger

数据模型

数据库模型

拓扑图

拓扑图

开发进度

开发进度

参与开发

首先谢谢大家支持,如果你希望参与开发,欢迎通过Github上fork本项目并Pull Request您的commit。

常见问题

  • Eclipse下dubbo找不到dubbo.xsd报错不影响使用如果要解决可参考 http://blog.csdn.net/gjldwz/article/details/50555922

  • 报zheng-xxx.jar包找不到,请按照文档编译顺序将源代码编译并安装到本地maven仓库

  • zheng-cms-admin启动卡住因为没有启动activemq

  • zheng-upms-server访问报session不存在因为没有启动redis服务

  • 界面没有样式因为zheng-admin没有编译安装到本地仓库

附件

优秀文章和博客

在线小工具

在线文档

许可证

MIT