Skip to content

Commit 50f34d5

Browse files
yuxiaobinyuxiaobin
committed
add En Doc for index page
1 parent 5b940f4 commit 50f34d5

File tree

2 files changed

+153
-5
lines changed

2 files changed

+153
-5
lines changed

‎en/guide/README.md

Lines changed: 149 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,149 @@
1-
# Guide
1+
# Guide
2+
3+
[MyBatis-Plus](https://github.com/baomidou/mybatis-plus)（MP for short）is an powerful enhanced tool for [MyBatis](http://www.mybatis.org/mybatis-3/) , Born To Simplify Development.
4+
5+
::: tip Vision
6+
Our Vision is to be the best Partner of Mybatis, just like Game: [Contra](/img/contra.jpg) , 1P&2P cooperate with doubled efficiency.
7+
:::
8+
9+
<p class="demo">
10+
<img src="/img/relationship-with-mybatis.png"/>
11+
</p>
12+
13+
14+
## Features
15+
16+
- **Non-invasion**：No change but enhancement, no effect for current project by importing MP
17+
- **Little loss**：Inject CRUD sql automatically when startup, almost non-loss, OOP(Object-Oriented Programming)
18+
- **Powerful CRUD**：general Mapper/Service inside, you can CURD by few configuration, powerful condition constructor can simplify programming. for single table CRUD, XML is needless
19+
- **Lambda**：Simplify query by using Lambda, and avoid column name typo
20+
- **Multiple DB**：Support MySQL, MariaDB, Oracle, DB2, H2, HSQL, SQLite, Postgre, SQLServer2005, SQLServer, etc.
21+
- **Auto generate PK**：4 strategies for Primay Key, free configuration
22+
- **ActiveRecord**：You can use entity for CRUD, just let entity extends Model
23+
- **Customize general methods**：You can customize general methods, "Write once, use anywhere"
24+
- **Code Generator**：You can generate Mapper/Model(Entity)/Service/Controller, and customized code template is also supportted(Freemarker, Velocity)
25+
- **Pagination**：Physical pagination, transparent to developers
26+
- **Performance Interceptor**：Can show sql execution time (Suggest to open it when doing development)
27+
- **Smart Interceptor**：Can stop execution of delete/update for full table, and customized intercepting rule is also supportted, which can prevent misoperation
28+
- **Sql Injection Interceptor**：Can detect and avoid the sql injection
29+
30+
## Structure
31+
32+
![framework](/img/mybatis-plus-framework.jpg)
33+
34+
## Code Repository
35+
36+
> **[Gitee](https://gitee.com/baomidou/mybatis-plus)** | **[Github](https://github.com/baomidou/mybatis-plus)**
37+
38+
[MyBatis-Plus Entry-level video tutorial(慕课)](https://www.imooc.com/learn/1130)
39+
40+
## Contribution
41+
42+
Your PR is apprecated!
43+
44+
- Code：repository [MyBatis-Plus](https://github.com/baomidou/mybatis-plus) , feel free to create Issue or PR
45+
- Doc：Repository [MyBatis-Plus-Doc](https://github.com/baomidou/mybatis-plus-doc) , feel free for PR
46+
47+
## Good Examples
48+
49+
::: tip
50+
名称登记按照时间先后，需加入列表的同学可以告诉我们。
51+
:::
52+
53+
- [SpringWind](https://gitee.com/baomidou/SpringWind)：Java EE（J2EE）快速开发框架
54+
- [Crown](https://gitee.com/cancerGit/Crown)：Mybatisplus 3.0 教学版
55+
- [Crab](https://gitee.com/atcrab/crab)：WEB 极速开发框架
56+
- [KangarooAdmin](https://git.oschina.net/zhougaojun/KangarooAdmin)：轻量级权限管理框架
57+
- [iBase4J](https://git.oschina.net/iBase4J/iBase4J)：Java 分布式快速开发基础平台
58+
- [framework](https://git.oschina.net/sunhan521/framework)：后台管理框架
59+
- [BMS](https://git.oschina.net/eric.xu/BMS)：基础权限开发框架
60+
- [spring-shiro-training](https://git.oschina.net/wangzhixuan/spring-shiro-training)：简单实用的权限脚手架
61+
- [center](https://git.oschina.net/willenfoo/center)：系统管理中心系统
62+
- [skeleton](https://github.com/fengchangsheng/skeleton)：Springboot-Shiro 脚手架
63+
- [springboot_mybatisplus](https://git.oschina.net/z77z/springboot_mybatisplus)：基于 SpringBoot 的美女图片爬虫系统
64+
- [guns](http://git.oschina.net/naan1993/guns)：guns 后台管理系统
65+
- [maple](https://git.oschina.net/blind/maple)：maple 企业信息化的开发基础平台
66+
- [jeeweb-mybatis](https://git.oschina.net/dataact/jeeweb-mybatis)：JeeWeb 敏捷开发平台
67+
- [youngcms](https://gitee.com/fumiao/youngcms)：CMS 平台
68+
- [king-admin](https://github.com/oukingtim/king-admin)：前后端分离的基础权限管理后台
69+
- [jeefast](https://gitee.com/theodo/jeefast)：前后端分离 Vue 快速开发平台
70+
- [bing-upms](https://gitee.com/xiaobingby/bing-upms)：SpringBoot + Shiro +FreeMarker 制作的通用权限管理
71+
- [slife](https://gitee.com/jamen/slife)：SpringBoot 企业级快速开发脚手架
72+
- [pig](https://gitee.com/log4j/pig)：微服务 Spring Cloud 架构
73+
- [mysiteforme](https://gitee.com/wanglingxiao/mysiteforme)：系统后台
74+
- [watchdog-framework](https://github.com/watchdog-framework/watchdog-framework)：基础权限框架
75+
- [iartisan-admin-template](https://gitee.com/iartisan/iartisan-admin-template)：Java 快速开发平台
76+
- [ifast](https://github.com/izenglong/ifast)：ifast 快速开发平台
77+
- [roses](https://gitee.com/naan1993/roses)：基于 Spring Cloud 的分布式框架
78+
- [renren-security](https://gitee.com/renrenio/renren-security)：人人权限系统
79+
- [freeter-admin](https://gitee.com/xcOschina/freeter-admin)：飞特后台管理系统
80+
- [vblog](https://gitee.com/seu-lfh/vblog)：VBlog 博客系统
81+
- [jiiiiiin-security](https://github.com/Jiiiiiin/jiiiiiin-security)：jiiiiiin权限系统
82+
- [hdw-dubbo](https://github.com/tumao2/hdw-dubbo)：HDW快速开发平台
83+
- [pybbs](https://github.com/tomoya92/pybbs)：更好用的Java语言社区(论坛)
84+
- [SmallBun](https://gitee.com/leshalv/smallbun)：SmallBun企业级开发脚手架
85+
- [webplus](https://gitee.com/imsroot/webplus)：综合开发平台
86+
- [x-boot](https://github.com/Exrick/x-boot)：VUE 前后端分离开发平台
87+
- [nice-blog-sys](https://gitee.com/KiWiPeach/nice-blog-sys)：基于SpirngBoot开发，好看的个人博客。
88+
89+
## Companies Using MP
90+
91+
::: tip
92+
名称按照登记先后，希望出现您公司名称的小伙伴可以告诉我们！
93+
:::
94+
95+
- 正保远程教育集团
96+
- 苏州罗想软件股份有限公司
97+
- 上海箱讯网络科技有限公司
98+
- 青岛帕特智能科技有限公司
99+
- 成都泰尔数据服务有限公司
100+
- 北京环球万合信息技术有限公司
101+
- 北京万学教育科技有限公司
102+
- 重庆声光电智联电子科技有限公司
103+
- 锦途停车服务（天津）有限公司
104+
- 浙江左中右电动汽车服务有限公司
105+
- 迪斯马森科技有限公司
106+
- 成都好玩123科技有限公司
107+
- 深圳华云声信息技术有限公司
108+
- 昆明万德科技有限公司
109+
- 浙江华坤道威
110+
- 南京昆虫软件有限公司
111+
- 上海营联信息技术有限公司
112+
- 上海绚奕网络技术有限公司
113+
- 四川淘金你我信息技术有限公司
114+
- 合肥迈思泰合信息科技有限公司
115+
- 深圳前海蚂蚁芯城科技有限公司
116+
- 广州金鹏集团有限公司
117+
- 安徽自由纪信息科技有限公司
118+
- 杭州目光科技有限公司
119+
- 迈普拉斯科技有限公司
120+
- 贵州红小牛数据有限公司
121+
- 天津市神州商龙科技股份有限公司
122+
- 安徽银通物联有限公司
123+
- 南宁九一在线信息科技有限公司
124+
- 青海智软网络科技有限公司
125+
- 安徽银基信息安全技术有限责任公司
126+
- 上海融宇信息技术有限公司
127+
- 北京奥维云网科技股份有限公司
128+
- 深圳市雁联移动科技有限公司
129+
- 广东睿医大数据有限公司
130+
- 武汉追忆那年网络科技有限公司
131+
- 成都艺尔特科技有限公司
132+
- 深圳市易帮云科技有限公司
133+
- 上海中科软科技股份有限公司
134+
- 北京熊小猫英语科技有限公司
135+
- 武汉桑梓信息科技有限公司
136+
- 腾讯科技（深圳）有限公司
137+
- 苏州环境云信息科技有限公司
138+
- 杭州阿启视科技有限公司
139+
- 杭州杰竞科技有限公司
140+
- 北京云图征信有限公司
141+
- 上海科匠信息科技有限公司
142+
- 深圳小鲨智能科技有限公司
143+
- 深圳市优加互联科技有限公司
144+
- 北京天赋通教育科技有限公司
145+
- 上海(壹美分)胤新信息科技有限公司
146+
- 厦门栗子科技有限公司
147+
- 山东畅想云教育科技有限公司
148+
- 成都云堆移动信息技术有限公司
149+
- 杭州一修鸽科技有限公司

‎en/guide/annotation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ Packages：
4747
| exist | boolean | N | true | false: NOT a column, just temporary property |
4848
| condition | String | N | "" | config the expression in where condition, by default it's `%s=#{%s}`, [reference](https://github.com/baomidou/mybatis-plus/blob/3.0/mybatis-plus-annotation/src/main/java/com/baomidou/mybatisplus/annotation/SqlCondition.java) |
4949
| update | String | N | "" | e.g. value="version", update="%s+1", when do update, 'version=version+1' will be appended to `update xx_table set xxx=xxx` (this property has higher priority than `el` ) |
50-
| insertStrategy | Enum | N | FieldStrategy.DEFAULT | specify the strategy of this column when do insert, e.g. NOT_NULL: `insert into table_a(<if test="columnProperty != null">column</if>) values (<if test="columnProperty != null">#{columnProperty}</if>)` (since v_3.1.2) |
51-
| updateStrategy | Enum | N | FieldStrategy.DEFAULT | specify the strategy of this column when do update, e.g. IGNORED: `update table_a set column=#{columnProperty}` (since v_3.1.2) |
52-
| whereStrategy | Enum | N | FieldStrategy.DEFAULT | specify the strategy of this column when do query, e.g. NOT_EMPTY: `where <if test="columnProperty != null and columnProperty!=''">column=#{columnProperty}</if>` (since v_3.1.2) |
53-
| fill | Enum | N | FieldFill.DEFAULT | auto fill strategy: INSERT, UPDATE, INSERT_UPDATE |
50+
| insertStrategy | Enum | N | DEFAULT | specify the strategy of this column when do insert, e.g. NOT_NULL: `insert into table_a(<if test="columnProperty != null">column</if>) values (<if test="columnProperty != null">#{columnProperty}</if>)` (since v_3.1.2) |
51+
| updateStrategy | Enum | N | DEFAULT | specify the strategy of this column when do update, e.g. IGNORED: `update table_a set column=#{columnProperty}` (since v_3.1.2) |
52+
| whereStrategy | Enum | N | DEFAULT | specify the strategy of this column when do query, e.g. NOT_EMPTY: `where <if test="columnProperty != null and columnProperty!=''">column=#{columnProperty}</if>` (since v_3.1.2) |
53+
| fill | Enum | N | DEFAULT | auto fill strategy: INSERT, UPDATE, INSERT_UPDATE |
5454
| select | boolean | N | true | false: this column will not appear in select expression |
5555
| keepGlobalFormat | boolean | N | false | whether keep the Global column name format(e.g. UnderscoreToCamelCase) (@since 3.1.1) |
5656

0 commit comments

Comments
 (0)