# stategen

**Repository Path**: smile_continue/stategen

## Basic Information

- **Project Name**: stategen
- **Description**: 通用springMvc/springBoot分布式非强迫性全栈架构(java服务端，H5、iOS、andriod前端)，内含大名鼎鼎的支付宝dalgen之freemarker开源实现之商用升级版dalgenX，是唯一支持迭代开发的全栈代码生成器，大量前、后端代码通过生成器生成，其中后端任意api直接生成前端网络调用、状态化、交互等相关代码，把前后端分离开发"拉"回来，目前前端已支持react(dva+umi+typescript)和flutter(provider),后续加入kotlin、swf。免去前端文档、调试、postman、mockjs...繁琐。开发中迭代生成，不改变原开发流程、生成80%代码,兼容后20%你自己的代码，拒绝挖坑！  https://github.com/stategen/stategen
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 3
- **Created**: 2020-08-17
- **Last Updated**: 2025-01-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 增加一篇论文介绍原理:[利用java反射和java-parser制作可以迭代、分布式、全栈代码生成器的研究](https://github.com/stategen/stategen/blob/master/%E5%88%A9%E7%94%A8java%E5%8F%8D%E5%B0%84%E5%92%8Cjava-parser%E5%88%B6%E4%BD%9C%E5%8F%AF%E4%BB%A5%E8%BF%AD%E4%BB%A3%E3%80%81%E5%88%86%E5%B8%83%E5%BC%8F%E3%80%81%E5%85%A8%E6%A0%88%E4%BB%A3%E7%A0%81%E7%94%9F%E6%88%90%E5%99%A8%E7%9A%84%E7%A0%94%E7%A9%B6.md)
#### 市面上代码生成器分类  
1. 一次性脚手架式：一次性生成/覆盖目标代码,用在项目初始化,如：maven初始化项目、各种网页配置生成。  
2. 持续脚手架式：分步生成/覆盖目标代码,如：MyBatis/Ibatis/Hibernate/ generator、dalgen,各种网页配置生成。  
3. 在已编辑的目标代码上再次生成。 如：StateGen(全网目前唯一?).
目前市面上的代码生成器都是前2种，而StateGen三种都有，StateGen开发生成器属于第3种.    
如果生成器只有前面2种，而为了不挖坑,要么只能做比较基本的生成，要么集成当时市面上所有时髦的技术，增加学习成本不说，
很快这些时髦都成为不时髦而且甩不掉的累赘，形成更大的坑，维护成本巨大。 
Stategen采用第三种生成方式可以豪无限制地兼容其它技术，所以无需扯一些不需要的技术当噱头、还把挖坑还当卖点。  
#### 关于分布式  
1. 市面上的分布式架构都是黑白分明的分布式，要布分布式，要么本地。   
2. 假如某服务本地能查找到，通常分布式流程：http请求->分布式路由->分布式服务(可能是本地)->序列化->分布式路由->本地反序列化->序列化->http出口  
   而StateGen是这样直接: http请求->本地服务->http出口   
3. 为什么StateGen能按照最快的走法,诀窍就是：java继承。简单地理解这个事：本项目下，所有的服务中选一些对外，而不是倒过来，
#### 关于spring 和 springboot    
1.  spring和springboot是两个并行的版本，springboot并不是spring的升级版，spring是功能完整的版本，springboot是对spring的脚手架式封装，相于当摄影中，傻瓜相机对于完整相机功能的封装。
1.  spring中xml配置是spring的根本，xml像文档中的纲要把beans管理起来。springboot是用java代码代替xml配置，递归读取Annotation加载beans，
这是用java反射形成树状beans管理，计算机处理这种结构无所谓，  
但人工从树的root找到某个leaf非常难，需翻阅大量的java代码，所以springboot项目非常不适合项目owner管理,甚至过一段时间，连开发人员自己不能确切地知道有哪些bean。     
1.  理由我说了，而且国内大型电商的招聘里一般更多地还要考察tomcat,jboss能力，这是为了把项目放到容器里调优。springboot不具有架构级别的调优功能或者很难。重构也非常难.
1.  stategen 支持在工程下把spring一键转换为springboot(命令 **gen.sh root -e**). 也可能手功变为**0-springboot-dependency**项目，但我仍然建议不要使用springboot管理项目。
4.  本架构的目的是为了制作**多模块、高并发、易管理、易交付、易维护，易重构**的前、后端项目。更迎合那些想把项目管理达到BAT水准的项目owner、开发者。
5.  至于部署，本架构服务端支持测试通过后由jenkins直接部署到生产，无需再改配置编译,避免人工疏忽.
#### 关于Ibatis or MyBatis or hibernate 和dalgenX
1.  SSH架构火了10年，其中hibernate支持自动生成sql的优势功不可没，但是再牛逼程序也不能满足复杂的sql自动生成,于是hibernate允许在java代码里掺杂hql和sql.
1.  上面的本意是给编程带来方便,但是一旦这个大门打开，就不能阻止开发人员进入，当java代码中混入大量的sql或hql后，项目离死也就不远了，除了难以维护，DBA也无法参与后期优化.
1.  当年，同期发展的ibatis被hibernate打得措手不及，由apache的顶级项目变成弃儿.但是正是ibatis的缺点：手写sql,解决了hibernate的先天不足，由是很多人在web2.0时代又重新转向了SSI架构。
1.  但是ibatis需要大写的手写配置，特别是xml配置,于是又出现了MyBatis(改名的很大原因是应对apache版权),稍微减轻了一些手写配置的开发工作量。
1.  但即使是MyBatis-gernerator也不能避免大量手写配置,还是影响开发效率，于是又出现了MyBatis plus,于是又回到了老路,在java代码混入大量的sql.特别是用java代码拼装where条件.
    项目的维护成本极高.像**在支付宝这样的公司这种是严格禁止的**。
1.  解决ibatis手写配置的开发瓶颈问题的是支付宝的天才程序员**程立**(支付宝CTO,首席架构师)开发的dalgen，有了dalgen，ibatis简洁sql执行效率反而是优势。可惜，除支付宝之外的公司很少知道dalgen的存在，而且dalgen不开源.
    直到2015年前我在taocode找到dalgen的freemarker简单开源实现，作者是**badqiu**. 
1.  上面的dalgen只能算demo,无法商用,但是思路完备，我结合工作中开发，不断地改造升级，现在已很好的支持商用，实际使用效果比支持宝的dalgen还方便很多，特别是支持迭代开发生成，
     这是代码生成器史上质的飞跃。由是改名叫dalgenX,之所以没有用其它的名子，是向2位天才和前人致敬。     
1.  dalgenX和dalgen一样，以及本架构内的前端生成器、脚手架，都属于开发阶段生成器，只生成预期的目标代码，不参与编译期和运行期， 
## StateGen原理:
   ### 关于前端
   >1.  对于后端一个任意给定的api,其对应的前端网络调用、数据状态化、交互代码基本都是确定和没有歧义的，既然是确定的，说明是规有律性的，找到规律就可以实现机器来生成，
   stategen在不增加学习和额外开发成本的情况下找到了这种规律，它避免了以往手工或半手工导致的不规范而增加开发、维护成本。现在stategen可以自动秒撸  
   >2.  经过分析,同一作用域中，任何新调用的api返回值与之前的数据之间的关系只有以下3种，如此，前端状态的自动化代码有了理论基础:
   >>a.  重新加载  
   >>b.  按主键增加或更新  
   >>c.  按主键删除  
   >3.  数据隔离  
     A.  按后端返回值类型隔离,同一个后端controller对应前端的model/provider，以下都是按 userArea 隔离  
       User,  
       List\<User\>   
       PageList\<User\>,  
       @State(area=User.class) public String delete(){}  
     B.  不同的Controller数据已经按model/provider隔离    
   >4. 以前生成代码方式有2种，配置和伪代码:这两种方式增加学习成本，看似节约时间，实际上要花费更多的时间在坑里维护代码，任何基于json或者配置做前端都是太菜了，stategen不这样做.
     StateGen直接通过java反射硬解析后端java代码来生成前端代码，没有任何多余工作环节或学习,不改变开发流程.当然也不存在挖坑  
    
 
     
   ### 关于后端
   >1. 对于任意一个sql,其配置、对应的java代码，参数个数，类型，返回值类型、字段都是确定的，这些以前都是手工或半手工撸出来.
   >2. 业务逻辑都是由调用一个或多个sql组成的
   >3. 市面上代码生成器都覆盖式生成代码,其生成的代码无法预先指定继承、实现接口、类型指定,无法保护已有业务代码成果,
       比如要多写功能相同逻辑的DTO绕开限制，但这违背单一职责框架设置原理，欲使用先入坑.StateGen采用解析已有java
       代码的方式解决上述问题
   ### 代码生成器难以解决的是问题迭代和增量开发,但是实际的项目开发都是不断地迭代功能和新功能叠加，而stategen非常适合迭代开发    
     
# StateGen已经支持flutter   
  采用google 2019 i/o大会上推荐的provider
##  最好的沟通是避免沟通   
![Image](https://github.com/stategen/docs/blob/master/category.png)  
![Image](https://github.com/stategen/docs/blob/master/homeApis.png)  
![Image](https://github.com/stategen/docs/blob/master/category_json.png)  
![Image](https://github.com/stategen/docs/blob/master/dva_react_model.png)  
![Image](https://github.com/stategen/docs/blob/master/flutter_goods_provider.png)  
![Image](https://github.com/stategen/docs/blob/master/stategenAppSnapshort.png)  
mobile端  
![Image](https://github.com/stategen/docs/blob/master/stategenWebSnapShort1.png)  
web端  
**上面2张图，按通常的开发量需要上千行代码，现在只需要开发10多行代码**  
本说明视频演示请移步[Stategen快速调试开发运行精简教程](https://v.youku.com/v_show/id_XNDIxMzM4ODQzMg==.html?spm=a2h3j.8428770.3416059.1)  
视频中的相关文档，请见 https://github.com/stategen/docs    
>**stategen不是创造技术，而是对现有常用j2ee技术的框架级开放式整合**   
>**开放式意思是和别的技术做兼容，而不是使用stategen后限定使用其它技术**  
>**无论使用哪种整合，必不可少的是基本代码的开发，通过dalgenX代码生成器可以减少前后端50-90%的工作量**  
>**dalgenX不同于常用代码生成器，它是可迭代、开放式代码生成器，可以在现有代码的基础上随迭代再次生成,再不是覆盖生成，保留之前的开发成果**  
>**dalgenX可很好地解决DDD技术中领域模型/pojo的胖、瘦问题，避免大量DTO的编写**  
>**最好的沟通是避免沟通,stategen可以避免大量后端、分布式、前后端文档编写，减少相互扯皮**

### Stategen快速调试运行

#### 运行环境
>1.	服务端/windows
>>A.	java 1.8  
B.	maven 3  
C.	mysql5.7  
D.	gitbash(安装git2.0 自带)  
E.	nodejs8+yarn  
>2.	单纯的前端/客户端开发  
>>A.	nodejs8+yarn  
  因为stg工程是git管理的， 前端是一个整个git项目的子项目

#### 开发环境安装
>1.	Install dubbox/或者发布dubbox至公司的私有仓库  
```
git clone https://github.com/dangdangdotcom/dubbox.git
mvn install –Dmaven.test.skip=true -e
```
>2.	Install stategen/或者发布stategen至公司的私有仓库
```
git clone --recursive https://github.com/stategen/stategen
mvn install –Dmaven.test.skip=true -e
```
(上面2步在有公司的私有maven仓库的情况下，只要发布一次就可以,并不是每台开发机上都要配置)
>3. 配置 dalgenX
```
git clone https://github.com/stategen/dalgenx.git
```
>>设置 DALGENX_HOME 环境变量为 dalgenx所在目录  
>>将 %DALGENX_HOME% 添加至 PATH 中  
#### Ide中配置（eclipse\idea）
>1.	location: {DALGENX_HOME}\gen.schemas-1.0.dtd  
key type: system Id  
key: https://github.com/stategen/dalgenx/blob/master/gen.schemas-1.0.dtd
>2.	location: {DALGENX_HOME}\dubbo.xsd    
key type: namespaces Name   
key: http://code.alibabatech.com/schema/dubbo/dubbo.xsd  


#### 用命令初始化系统及项目/范例
>1.创建系统
```
gen.sh system com.mycompany.biz trade -e  
```
>>com.mycompany.biz 为包名   
>>trade 系统名 /数据库名 dubbox 系统名    

>2.创建cms项目	
```
gen.sh project cms web –e  
```
>>cms 项目名称
>>web 以web(模版所在的文件夹生成前端) ，目前提供2个模版web|app，不要这个参数，即没有前端
	
>3.创建app项目	
```
gen.sh project app app –e  
```
>4.创建shedule项目,不带前端	
```
gen.sh project schedule –e  
```

>5.gitbash 中 运行  xxx-frontend目录下git_add_to_parent_as_sub.sh，变为git项目和子项目   
>6.sourceTree查看文件并提交  
>7.	环境及表  
>> 创建trade数据库并运行 运行 trade.sql，,city hoppy region province user_hoppy topic*都是演示表  
>>把opt复制到同盘根目录下  
>>修改gen_config.xml中的数据库配置  
>>先后在 gitbatsh中运行 tablebatch.sh 和 dalbatch.sh 批量生成缺失的文件  
>8.sourceTree查看文件并提交  

#### 一个典型Stategen 系统 结构图
![Image](https://github.com/stategen/docs/blob/master/stg-fm-bbr.png) 


#### 演示Teacher需求开发
```
DROP TABLE IF EXISTS `teacher`;
CREATE TABLE `teacher` (
  `teacher_id` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL COMMENT '老师ID',
  `teacher_name` varchar(64) DEFAULT NULL COMMENT '老师名',
  `password` varchar(64) DEFAULT NULL COMMENT '密码，测试，明文',
  `role_type` varchar(32) DEFAULT NULL COMMENT '老师角色 ADMIN,DEFAULT,DEVELOPER',
  `name` varchar(64) DEFAULT NULL COMMENT '姓名',
  `nickName` varchar(32) DEFAULT NULL COMMENT '别名',
  `age` int(11) DEFAULT NULL COMMENT '年龄',
  `address` varchar(255) DEFAULT NULL COMMENT '详细地址',
  `avatar_img_id` varchar(64) DEFAULT NULL COMMENT '头像 ID',
  `email` varchar(128) DEFAULT NULL COMMENT '邮箱',
  `vali_datetime` datetime DEFAULT NULL COMMENT '认证时间',
  `birthday_date` date DEFAULT NULL COMMENT '出生日期',
  `work_time` time DEFAULT NULL COMMENT '工作时间',
  `province_id` varchar(64) DEFAULT NULL COMMENT '省份 ID',
  `city_id` varchar(64) DEFAULT NULL COMMENT '城市 ID',
  `status` varchar(64) DEFAULT NULL COMMENT '状态 enum',
  `grade` bigint(2) DEFAULT NULL COMMENT '级别',
  `sex` tinyint(1) DEFAULT NULL COMMENT '性别',
  `post_address_id` bigint(20) DEFAULT NULL COMMENT '邮寄地址 ID',
  `remark` text,
  `create_time` datetime(6) DEFAULT NULL COMMENT '创建时间',
  `update_time` datetime(6) DEFAULT NULL COMMENT '更新时间',
  `delete_flag` int(1) DEFAULT NULL COMMENT '是否删除 (0:正常，1删除)',
  PRIMARY KEY (`teacher_id`),
  UNIQUE KEY `email` (`email`),
  UNIQUE KEY `teacher_name` (`teacher_name`),
  KEY `province_id` (`province_id`),
  KEY `city_id` (`city_id`)
) ENGINE=MyISAM AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4;

```
>1.运行命令生成表sql配置和java代码
```
gen.sh table teacher –e
```
>2.检查teacher.xml对应的java类是否正确，去掉?及一行空格
```
gen.sh dal teacher –e
```
>3.F5刷新eclipse 检查import是否完整  
>4.手动做一个controller或者用命令初始化一个controller
```
gen.sh api teacher cms|app
```
>5.	eclipse打开查看是否有代码错误


#### 生成前端代码，开发前端
>1.	运行test/UmiFacadeProcessor.java   
>2.	webstorm打开前端代码 ，配置webpack解读代码  
>3.	yarn 下载前端依赖  
>4.	fiddler 脚本设置 onBeforeRequest  
```
        var url:String=oSession.PathAndQuery;
  
        if (oSession.host=="localhost:8000") {         
            if ( url.StartsWith("/tradeCms/api/") || url.StartsWith("/tradeCms/uploads/") ) {
                oSession.host="localhost:8080";
            }            
        } 
        else if (oSession.host=="localhost:8001") {
            if ( url.StartsWith("/tradeApp/api/") || url.StartsWith("/tradeApp/uploads/") ) {
                oSession.host="localhost:8080";
            }            
        }
```        

>5.	后端发布到eclipse tomcat中,运行  
>6.	yarn run dev  


#### 打包 前后端
```
mvn package 
```

### 其它
#### 开启 dubbox, 
>反注释 dubbo-provider-spring.xml 中的
```
    <!-- <import resource="classpath*:context/dubbo-provider-auto-*.xml" /> -->
    <!-- <import resource="classpath*:context/dubbo-provider-manual-*.xml" /> -->
```  
### Stategen中 spring bean都是显示配置的 
### StategenMvc框架几处用法,可以避免在业务中频繁地写与业务无关的代码，这些用法是自定义配置的
#### MultiFilter.java 配置在web.xml，它对客户端的请求CookieGroup检测是否伪造,CookieGroup可以配置多个,便于业务分组.每个CookieGroup下的所有cookie都有一个离伪造的token签名，
```
<filter>
    <filter-name>frameworkMultiFilter</filter-name>
    <filter-class>org.stategen.framework.spring.mvc.MultiFilter</filter-class>
</filter>
```
```
<!-- 验证cookie分组 ,该类可以多个，配置不同的分组 -->
<bean id="loginCookieGroup" class="org.stategen.framework.web.cookie.CookieGroup">
    <property name="cookieTypeClz" value="com.mycompany.biz.enums.CookieType.Login" />
    <property name="httpOnly" value="${loginCookieGroupHttpOnly}"/>
</bean>
```

#### @Wrap 对Spring Controller中@Requestbody 返回值按指定的类再包装,便于前端兼容
比如:
```
    <bean id="response" class="com.mycompany.biz.domain.Response" scope="prototype">
    </bean>
```
包装后的
```
{
message:'成功'
success:true,
data:xxxx
...
}
```

#### CollectExceptionJsonHandler.java 对业务异常、运行异常统一处理
```
    <bean class="org.stategen.framework.spring.mvc.CollectExceptionJsonHandler">
        <property name="responseStatusClzOfException" value="com.mycompany.biz.enums.ResponseStatus.ERROR" />
    </bean>
```

####各种自定义的标注如 @LoginCheck .... 按指定的方式检查权限
```
    <bean class="com.mycompany.biz.checker.VisitChecker" />
    <bean class="com.mycompany.biz.checker.LoginChecker" />
```

####@ApiRequestMappingAutoWithMethodName
在SpringMvc,以方法名作为路径，避免写路径硬编码，

[Stategen快速调试开发运行精简教程](https://v.youku.com/v_show/id_XNDIxMzM4ODQzMg==.html?spm=a2h3j.8428770.3416059.1)  
### 详细视频 共6小时
[1.stategen之前 微博 趣图](https://v.youku.com/v_show/id_XNDIwODcxNzk2OA==.html?spm=a2h3j.8428770.3416059.1)          
[2.stategen简介](https://v.youku.com/v_show/id_XNDIwOTk1MjE0MA==.html?spm=a2h3j.8428770.3416059.1)          
[3.stategen依赖环境](https://v.youku.com/v_show/id_XNDIwOTk1Mzc2OA==.html?spm=a2h3j.8428770.3416059.1)          
[4.stategen安装和配置](https://v.youku.com/v_show/id_XNDIwOTc4MTU1Mg==.html?spm=a2h3j.8428770.3416059.1)          
[5.生成stategen系统以及工程](https://v.youku.com/v_show/id_XNDIwOTg5MjQ0MA==.html?spm=a2h3j.8428770.3416059.1)          
[6.stategen服务端开发代码演示(上)](https://v.youku.com/v_show/id_XNDIwOTg5MjM3Mg==.html?spm=a2h3j.8428770.3416059.1)          
[7.stategen服务端开发代码演示_迭代开发(中)](https://v.youku.com/v_show/id_XNDIwOTg5MjM5Ng==.html?spm=a2h3j.8428770.3416059.1)          
[8.stategen.mvc](https://v.youku.com/v_show/id_XNDIwOTkxNDg1Mg==.html?spm=a2h3j.8428770.3416059.1)          
[9.stategen前端简介](https://v.youku.com/v_show/id_XNDIwOTkxNDgyOA==.html?spm=a2h3j.8428770.3416059.1)          
[10.stategen前端dva](https://v.youku.com/v_show/id_XNDIwOTkxNDg2MA==.html?spm=a2h3j.8428770.3416059.1)          
[11.stategen前端form 生成和实现](https://v.youku.com/v_show/id_XNDIwOTkxNDgzNg==.html?spm=a2h3j.8428770.3416059.1)          
[12.stategen运行前后端和开发](https://v.youku.com/v_show/id_XNDIwOTk1Mzc4NA==.html?spm=a2h3j.8428770.3416059.1)          
### 鸣谢
   [react] https://github.com/facebook/react，   
   [ant-design] https://github.com/ant-design/ant-design   
   [dva] https://github.com/dvajs/dva   
   [umi] https://github.com/umijs   
   [rapid-framework] https://github.com/badqiu/rapid-framework    
   [zuiidea] https://github.com/zuiidea/antd-admin   
   [dubbox] https://dangdangdotcom.github.io/dubbox   
   [spring-framework] https://github.com/spring-projects/spring-framework   
   ...