完善文档

abel533 · abel533 · commit 377bb32a1b74 · 2015-08-30T00:37:51.000+08:00
diff --git a/src/main/java/tk/mybatis/mapper/annotation/KeyProperty.java b/src/main/java/tk/mybatis/mapper/annotation/KeyProperty.java
diff --git a/src/main/java/tk/mybatis/mapper/entity/EntityColumn.java b/src/main/java/tk/mybatis/mapper/entity/EntityColumn.java
@@ -14,7 +14,6 @@ public class EntityColumn {
     private boolean id = false;
     private boolean uuid = false;
     private boolean identity = false;
-    private boolean key = false;
     private String generator;
     private String orderBy;
 
@@ -105,14 +104,6 @@ public void setOrderBy(String orderBy) {
         this.orderBy = orderBy;
     }
 
-    public boolean isKey() {
-        return key;
-    }
-
-    public void setKey(boolean key) {
-        this.key = key;
-    }
-
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
diff --git a/src/main/java/tk/mybatis/mapper/mapperhelper/EntityHelper.java b/src/main/java/tk/mybatis/mapper/mapperhelper/EntityHelper.java
@@ -24,7 +24,6 @@
 
 package tk.mybatis.mapper.mapperhelper;
 
-import tk.mybatis.mapper.annotation.KeyProperty;
 import tk.mybatis.mapper.annotation.NameStyle;
 import tk.mybatis.mapper.code.IdentityDialect;
 import tk.mybatis.mapper.code.Style;
@@ -235,10 +234,6 @@ public static synchronized void initEntityNameMap(Class<?> entityClass, Style st
                     entityColumn.setOrderBy(orderBy.value());
                 }
             }
-            //KeyProperty
-            if (field.isAnnotationPresent(KeyProperty.class)) {
-                entityColumn.setKey(true);
-            }
             //主键策略 - Oracle序列，MySql自动增长，UUID
             if (field.isAnnotationPresent(SequenceGenerator.class)) {
                 SequenceGenerator sequenceGenerator = field.getAnnotation(SequenceGenerator.class);
diff --git a/wiki/mapper3/2.Integration.md b/wiki/mapper3/2.Integration.md
@@ -23,16 +23,21 @@ http://repo1.maven.org/maven2/tk/mybatis/mapper
 
 http://repo1.maven.org/maven2/javax/persistence/persistence-api/1.0/
 
-##集成通用Mapper - 3.2.0版本以后配置更简单，以前的拦截器不能继续使用
+##集成通用Mapper
+
+3.2.0版本以后配置更简单，以前的拦截器不能继续使用。
 
 配置方式分为Java编码方式和spring集成方式。
 
-###1). Mybatis配置文件方式
+###1). Java编码方式
 
 ```java
 MapperHelper mapperHelper = new MapperHelper();
-// 各项配置都能通过setter进行配置
-// 注册通用Mapper接口 - 可以自动注册继承的接口
+//特殊配置
+Config config = new Config();
+//具体支持的参数看后面的文档
+config.setXXX(XXX);
+// 注册自己项目中使用的通用Mapper接口，这里没有默认值，必须手动注册
 mapperHelper.registerMapper(Mapper.class);
 //配置完成后，执行下面的操作
 mapperHelper.processConfiguration(session.getConfiguration());
@@ -61,21 +66,12 @@ mapperHelper.processConfiguration(session.getConfiguration());
 </bean>
 ```
 
+关于MyBatis-Spring详细配置的可以查看[MyBatis-Spring配置简单了解](http://blog.csdn.net/isea533/article/details/45640319)
+
+<br><br><br><br><br><br><br>
+##可配参数介绍
+
 
-###INENTITY参数配置（仅对 insert 有用）
-
-对于不同的数据库，需要配置不同的参数，这些参数如下：
- 
-- <b>DB2</b>: `VALUES IDENTITY_VAL_LOCAL()`  
-- <b>MYSQL</b>: `SELECT LAST_INSERT_ID()`  
-- <b>SQLSERVER</b>: `SELECT SCOPE_IDENTITY()`  
-- <b>CLOUDSCAPE</b>: `VALUES IDENTITY_VAL_LOCAL()`  
-- <b>DERBY</b>: `VALUES IDENTITY_VAL_LOCAL()`  
-- <b>HSQLDB</b>: `CALL IDENTITY()`  
-- <b>SYBASE</b>: `SELECT @@IDENTITY`  
-- <b>DB2_MF</b>: `SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1`  
-- <b>INFORMIX</b>: `select dbinfo('sqlca.sqlerrd1') from systables where tabid=1`
-- <b>JDBC</b>:这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键（比如：像 MySQL 和 SQL Server 这样的关系数据库管理系统的自动递增字段）。
 
 #[如何使用通用Mapper](http://git.oschina.net/free/Mapper/blob/master/wiki/mapper3/3.Use.md)
 
diff --git a/wiki/mapper3/3.Use.md b/wiki/mapper3/3.Use.md
@@ -17,6 +17,7 @@ public interface UserInfoMapper extends Mapper<UserInfo> {
 
 一旦继承了`Mapper<T>`,继承的`Mapper`就拥有了`Mapper<T>`所有的通用方法。
 
+<br><br><br><br>
 ##2. 泛型(实体类)`<T>`的类型必须符合要求
 
 实体类按照如下规则和数据库表进行转换,注解全部是JPA中的注解:
@@ -31,105 +32,135 @@ public interface UserInfoMapper extends Mapper<UserInfo> {
 
 5. 使用`@Transient`注解可以忽略字段,添加该注解的字段不会作为表字段使用.
 
-6. 建议一定是有一个`@Id`注解作为主键的字段,可以有多个`@Id`注解的字段作为联合主键.
+6. <b>建议一定是有一个`@Id`注解作为主键的字段,可以有多个`@Id`注解的字段作为联合主键.</b>
 
-7. 默认情况下,实体类中如果不存在包含`@Id`注解的字段,所有的字段都会作为主键字段进行使用(这种效率极低).
+7. <b>默认情况下,实体类中如果不存在包含`@Id`注解的字段,所有的字段都会作为主键字段进行使用(这种效率极低).</b>
 
 8. 实体类可以继承使用,可以参考测试代码中的`tk.mybatis.mapper.model.UserLogin2`类.
 
 9. 由于基本类型,如int作为实体类字段时会有默认值0,而且无法消除,所以实体类中建议不要使用基本类型.
 
-除了上面提到的这些,Mapper还提供了序列(支持Oracle)、UUID(任意数据库,字段长度32)、主键自增(类似Mysql,Hsqldb)三种方式，其中序列和UUID可以配置多个，主键自增只能配置一个。
+10. `@NameStyle`注解，用来配置对象名/字段和表名/字段之间的转换方式，该注解优先于全局配置`style`，可选值：
+   - `normal`:使用实体类名/属性名作为表名/字段名
+   - `camelhump`:<b>这是默认值</b>，驼峰转换为下划线形式
+   - `uppercase`:转换为大写
+   - `lowercase`:转换为小写
 
-这三种方式不能同时使用,同时存在时按照 `序列>UUID>主键自增`的优先级进行选择.下面是具体配置方法:
+通过[使用Mapper专用的MyBatis生成器插件](http://git.oschina.net/free/Mapper/blob/master/wiki/mapper3/7.UseMBG.md)可以直接生成符合要求带注解的实体类。
+
+<br><br><br><br>
+
+<br><br><br><br>
+##3.主键策略(仅用于insert方法) - 将会在3.3.0版本移除，使用新的简单的注解
+
+通用Mapper还提供了序列(支持Oracle)、UUID(任意数据库,字段长度32)、主键自增(类似Mysql,Hsqldb)三种方式，其中序列和UUID可以配置多个，主键自增只能配置一个。
+
+由于MySql自增主键最常用，所以这里从最简单的配置方式开始。
+
+###1.`@GeneratedValue(generator = "JDBC")`
 
-1. 使用序列可以添加如下的注解:
 ```java
-//可以用于数字类型,字符串类型(需数据库支持自动转型)的字段
-@SequenceGenerator(name="Any",sequenceName="seq_userid")
 @Id
+@GeneratedValue(generator = "JDBC")
 private Integer id;
 ```
-该字段不会回写。这种情况对应类似如下的XML：
-  ```xml
-  <insert id="insertAuthor">
-      insert into Author
-        (id, username, password, email,bio, favourite_section)
-      values
-        (seq_userid.nextval, #{username, #{password}, #{email}, #{bio}, #{favouriteSection,jdbcType=VARCHAR})
-  </insert>
-  ```   
-
-2. 使用UUID时:
-```java
-//可以用于任意字符串类型长度超过32位的字段
-@GeneratedValue(generator = "UUID")
-private String username;
+
+这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键（比如：像 MySQL 和 SQL Server 这样的关系数据库管理系统的自动递增字段）。
+这种情况对应的xml类似下面这样:
+```xml
+<insert id="insertAuthor" useGeneratedKeys="true" keyProperty="id">
+    insert into Author (username,password,email,bio)
+    values (#{username},#{password},#{email},#{bio})
+</insert>
 ```
-该字段不会回写。这种情况对应类似如下的XML：
-  ```xml
-  <insert id="insertAuthor">
-      <bind name="username_bind" value='@java.util.UUID@randomUUID().toString().replace("-", "")' />
-      insert into Author
-        (id, username, password, email,bio, favourite_section)
-      values
-        (#{id}, #{username_bind}, #{password}, #{email}, #{bio}, #{favouriteSection,jdbcType=VARCHAR})
-  </insert>
-  ```
-
-3. 使用主键自增:
+
+###2.`@GeneratedValue(strategy = GenerationType.IDENTITY)`
+
+这个注解适用于主键自增的情况，支持下面这些数据库：
+
+- <b>DB2</b>: `VALUES IDENTITY_VAL_LOCAL()`
+- <b>MYSQL</b>: `SELECT LAST_INSERT_ID()`
+- <b>SQLSERVER</b>: `SELECT SCOPE_IDENTITY()`
+- <b>CLOUDSCAPE</b>: `VALUES IDENTITY_VAL_LOCAL()`
+- <b>DERBY</b>: `VALUES IDENTITY_VAL_LOCAL()`
+- <b>HSQLDB</b>: `CALL IDENTITY()`
+- <b>SYBASE</b>: `SELECT @@IDENTITY`
+- <b>DB2_MF</b>: `SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1`
+- <b>INFORMIX</b>: `select dbinfo('sqlca.sqlerrd1') from systables where tabid=1`
+- <b>JDBC</b>:这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键（比如：像 MySQL 和 SQL Server 这样的关系数据库管理系统的自动递增字段）。
+
+使用`GenerationType.IDENTITY`需要在全局配置中配置`IDENTITY`的参数值，并且需要根据数库配置`ORDER`属性。
+
+举例如下：
+
 ```java
 //不限于@Id注解的字段,但是一个实体类中只能存在一个(继承关系中也只能存在一个)
 @Id
 @GeneratedValue(strategy = GenerationType.IDENTITY)
 private Integer id;
-```  
-增加这个注解后，__会回写ID__。
-
-  通过设置`@GeneratedValue`的`generator`参数可以支持更多的获取主键的方法，例如在Oracle中使用序列：
-  ```java
-  @Id
-  @GeneratedValue(strategy = GenerationType.IDENTITY,generator = "select SEQ_ID.nextval from dual")
-  private Integer id;
-  ```  
-  使用Oracle序列的时候，还需要配置:
-  ```xml
-  <property name="ORDER" value="BEFORE"/>
-  ```
-  因为在插入数据库前，需要先获取到序列值，否则会报错。  
-  这种情况对于的xml类似下面这样：  
-  ```xml
-  <insert id="insertAuthor">
-    <selectKey keyProperty="id" resultType="int" order="BEFORE">
-      select SEQ_ID.nextval from dual
+```
+
+对应的XML形式为：
+
+```xml
+<insert id="insertAuthor">
+    <selectKey keyProperty="id" resultType="int" order="AFTER">
+      SELECT LAST_INSERT_ID()
     </selectKey>
     insert into Author
       (id, username, password, email,bio, favourite_section)
     values
       (#{id}, #{username}, #{password}, #{email}, #{bio}, #{favouriteSection,jdbcType=VARCHAR})
-  </insert>
-  ```
+</insert>
+```
+
+注意`<selectKey>`中的内容就是`IDENTITY`参数值对应数据库的SQL
 
-4. 主键自增还有一种简单的写法：  
+###3.`@GeneratedValue(generator = "UUID")`
 ```java
-//不限于@Id注解的字段,但是一个实体类中只能存在一个(继承关系中也只能存在一个)
-@GeneratedValue(generator = "JDBC")
-private Integer id;
+//可以用于任意字符串类型长度超过32位的字段
+@GeneratedValue(generator = "UUID")
+private String username;
+```
+该字段不会回写。这种情况对应类似如下的XML：
+```xml
+<insert id="insertAuthor">
+  <bind name="username_bind" value='@java.util.UUID@randomUUID().toString().replace("-", "")' />
+  insert into Author
+    (id, username, password, email,bio, favourite_section)
+  values
+    (#{id}, #{username_bind}, #{password}, #{email}, #{bio}, #{favouriteSection,jdbcType=VARCHAR})
+</insert>
 ```
-  这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键（比如：像 MySQL 和 SQL Server 这样的关系数据库管理系统的自动递增字段）。
-  这种情况对应的xml类似下面这样:
-  ```xml
-  <insert id="insertAuthor" useGeneratedKeys="true" keyProperty="id">
-    insert into Author (username,password,email,bio)
-    values (#{username},#{password},#{email},#{bio})
-  </insert>
-  ```
 
+###4.Oracle使用序列
+```java
+@Id
+@GeneratedValue(strategy = GenerationType.IDENTITY,generator = "select SEQ_ID.nextval from dual")
+private Integer id;
+```
+使用Oracle序列的时候，还需要配置:
+```xml
+<property name="ORDER" value="BEFORE"/>
+```
+因为在插入数据库前，需要先获取到序列值，否则会报错。
+这种情况对于的xml类似下面这样：
+```xml
+<insert id="insertAuthor">
+<selectKey keyProperty="id" resultType="int" order="BEFORE">
+  select SEQ_ID.nextval from dual
+</selectKey>
+insert into Author
+  (id, username, password, email,bio, favourite_section)
+values
+  (#{id}, #{username}, #{password}, #{email}, #{bio}, #{favouriteSection,jdbcType=VARCHAR})
+</insert>
+```
 
 
-##3. 将继承的Mapper接口添加到Mybatis配置中
+##4. 将继承的Mapper接口添加到Mybatis配置中
 
-例如本项目测试中的配置:
+###非Spring项目中在mybatis配置文件中配置，如:
 ```xml
 <mappers>
   <mapper class="tk.mybatis.mapper.mapper.CountryMapper" />
@@ -138,18 +169,27 @@ private Integer id;
 </mappers>
 ```
 
-<b>附:Spring配置相关</b>
+###Spring配置方式
 
 如果你在Spring中配置Mapper接口,不需要像上面这样一个个配置,只需要有下面的这个扫描Mapper接口的这个配置即可:
 ```xml
-<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
+<bean class="tk.mybatis.spring.mapper.MapperScannerConfigurer">
   <property name="basePackage" value="com.isea533.mybatis.mapper"/>
 </bean>
-```  
+```
+
+另外因为通用接口都有顶层的接口，所以你还可以用下面的方式进行配置：
+```xml
+<bean class="tk.mybatis.spring.mapper.MapperScannerConfigurer">
+  <property name="basePackage" value="com.**.mapper"/>
+  <property name="markerInterface" value="tk.mybatis.mapper.common.Mapper"/>
+</bean>
+```
+这样配置后，直接继承了`Mapper`接口的才会被扫描，`basePackage`可以配置的范围更大。
 
 如果想在Spring4中使用泛型注入，还需要包含`Mapper<T>`所在的包，具体请看 [在Spring4中使用通用Mapper](http://git.oschina.net/free/Mapper/blob/master/wiki/UseMapperInSpring4.md)。  
 
-##4. 代码中使用
+##5. 代码中使用
 
 例如下面这个简单的例子:
 ```java
@@ -200,7 +240,7 @@ try {
 
 直接在需要的地方注入Mapper继承的接口即可,和一般情况下的使用没有区别.
 
-##5.其他  
+##6.其他
 
 如果你的实体是继承Map的，你可能需要将数据库查询的结果从大写下划线形式转换为驼峰形式，你可以搭配下面的拦截器使用：  
 
