Mybatis-JavaAPI

时间  2019-12-19
标签 mybatis javaapi 栏目 MyBatis 繁體版
原文   原文链接

 

Java API

 

既然你已经知道如何配置 MyBatis 和建立映射文件，你就已经准备好来提高技能了。MyBatis 的 Java API 就是你收获你所作的努力的地方。正如你即将看到的，和 JDBC 相比，MyBatis 很大程度简化了你的代码并保持代码简洁，容易理解并维护。MyBatis 3 已经引入了不少重要的改进来使得 SQL 映射更加优秀。java

应用目录结构

 

在咱们深刻 Java API 以前，理解关于目录结构的最佳实践是很重要的。MyBatis 很是灵活，你能够用你本身的文件来作几乎全部的事情。可是对于任一框架，都有一些最佳的方式。  web

让咱们看一下典型的应用目录结构：   sql

/my_application
  /bin
  /devlib
  /lib                <-- MyBatis *.jar 文件在这里。
  /src
    /org/myapp/
      /action
      /data           <-- MyBatis 配置文件在这里, 包括映射器类, XML 配置, XML 映射文件。
        /mybatis-config.xml
        /BlogMapper.java
        /BlogMapper.xml
      /model
      /service
      /view
    /properties       <-- 在你 XML 中配置的属性文件在这里。
  /test
    /org/myapp/
      /action
      /data
      /model
      /service
      /view
    /properties
  /web
    /WEB-INF
      /web.xml

固然这是推荐的目录结构，并不是强制要求，可是使用一个通用的目录结构将更利于你们沟通。数据库

这部份内容剩余的示例将假设你使用了这种目录结构。apache

SqlSessions

 

使用 MyBatis 的主要 Java 接口就是 SqlSession。你能够经过这个接口来执行命令，获取映射器和管理事务。咱们会归纳讨论一下 SqlSession 自己，可是首先咱们仍是要了解如何获取一个 SqlSession 实例。SqlSessions 是由 SqlSessionFactory 实例建立的。SqlSessionFactory 对象包含建立 SqlSession 实例的全部方法。而 SqlSessionFactory 自己是由 SqlSessionFactoryBuilder 建立的，它能够从 XML、注解或手动配置 Java 代码来建立 SqlSessionFactory。数组

注意 当 Mybatis 与一些依赖注入框架（如 Spring 或者 Guice）同时使用时，SqlSessions 将被依赖注入框架所建立，因此你不须要使用 SqlSessionFactoryBuilder 或者 SqlSessionFactory，能够直接看 SqlSession 这一节。请参考 Mybatis-Spring 或者 Mybatis-Guice 手册了解更多信息。缓存

SqlSessionFactoryBuilder

 

SqlSessionFactoryBuilder 有五个 build() 方法，每一种都容许你从不一样的资源中建立一个 SqlSession 实例。安全

SqlSessionFactory build(InputStream inputStream) SqlSessionFactory build(InputStream inputStream, String environment) SqlSessionFactory build(InputStream inputStream, Properties properties) SqlSessionFactory build(InputStream inputStream, String env, Properties props) SqlSessionFactory build(Configuration config)
    

第一种方法是最经常使用的，它使用了一个参照了 XML 文档或上面讨论过的更特定的 mybatis-config.xml 文件的 Reader 实例。可选的参数是 environment 和 properties。environment 决定加载哪一种环境，包括数据源和事务管理器。好比：session

<environments default="development"> <environment id="development"> <transactionManager type="JDBC"> ... <dataSource type="POOLED"> ... </environment> <environment id="production"> <transactionManager type="MANAGED"> ... <dataSource type="JNDI"> ... </environment> </environments>
    

若是你调用了参数有 environment 的 build 方法，那么 MyBatis 将会使用 configuration 对象来配置这个 environment。固然，若是你指定了一个不合法的 environment，你就会获得错误提示。若是你调用了不带 environment 参数的 build 方法，那么就使用默认的 environment（在上面的示例中指定为 default="development" 的代码）。mybatis

   

若是你调用了参数有 properties 实例的方法，那么 MyBatis 就会加载那些 properties（属性配置文件），并在配置中可用。那些属性能够用${propName} 语法形式屡次用在配置文件中。

 

回想一下，属性能够从 mybatis-config.xml 中被引用，或者直接指定它。所以理解优先级是很重要的。咱们在文档前面已经说起它了，可是这里要再次重申：

 

若是一个属性存在于这些位置，那么 MyBatis 将会按照下面的顺序来加载它们：

     
  • 首先读取在 properties 元素体中指定的属性；
    •  
  • 其次，读取从 properties 元素的类路径 resource 或 url 指定的属性，且会覆盖已经指定了的重复属性；
    •  
  • 最后，读取做为方法参数传递的属性，且会覆盖已经从 properties 元素体和 resource 或 url 属性中加载了的重复属性。
 

所以，经过方法参数传递的属性的优先级最高，resource 或 url 指定的属性优先级中等，在 properties 元素体中指定的属性优先级最低。  

 

总结一下，前四个方法很大程度上是相同的，可是因为覆盖机制，便容许你可选地指定 environment 和/或 properties。如下给出一个从 mybatis-config.xml 文件建立 SqlSessionFactory 的示例：

    
String resource = "org/mybatis/builder/mybatis-config.xml"; InputStream inputStream = Resources.getResourceAsStream(resource); SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder(); SqlSessionFactory factory = builder.build(inputStream);
      

注意到这里咱们使用了 Resources 工具类，这个类在 org.apache.ibatis.io 包中。Resources 类正如其名，会帮助你从类路径下、文件系统或一个 web URL 中加载资源文件。看一下这个类的源代码或者经过你的 IDE 来查看，就会看到一整套至关实用的方法。这里给出一个简表：

URL getResourceURL(String resource) URL getResourceURL(ClassLoader loader, String resource) InputStream getResourceAsStream(String resource) InputStream getResourceAsStream(ClassLoader loader, String resource) Properties getResourceAsProperties(String resource) Properties getResourceAsProperties(ClassLoader loader, String resource) Reader getResourceAsReader(String resource) Reader getResourceAsReader(ClassLoader loader, String resource) File getResourceAsFile(String resource) File getResourceAsFile(ClassLoader loader, String resource) InputStream getUrlAsStream(String urlString) Reader getUrlAsReader(String urlString) Properties getUrlAsProperties(String urlString) Class classForName(String className)
 

最后一个 build 方法的参数为 Configuration 实例。configuration 类包含你可能须要了解 SqlSessionFactory 实例的全部内容。Configuration 类对于配置的自查颇有用，它包含查找和操做 SQL 映射（当应用接收请求时便不推荐使用）。做为一个 Java API 的 configuration 类具备全部配置的开关，这些你已经了解了。这里有一个简单的示例，教你如何手动配置 configuration 实例，而后将它传递给 build() 方法来建立 SqlSessionFactory。

DataSource dataSource = BaseDataTest.createBlogDataSource(); TransactionFactory transactionFactory = new JdbcTransactionFactory(); Environment environment = new Environment("development", transactionFactory, dataSource); Configuration configuration = new Configuration(environment); configuration.setLazyLoadingEnabled(true); configuration.setEnhancementEnabled(true); configuration.getTypeAliasRegistry().registerAlias(Blog.class); configuration.getTypeAliasRegistry().registerAlias(Post.class); configuration.getTypeAliasRegistry().registerAlias(Author.class); configuration.addMapper(BoundBlogMapper.class); configuration.addMapper(BoundAuthorMapper.class); SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder(); SqlSessionFactory factory = builder.build(configuration);
 

如今你就得到一个能够用来建立 SqlSession 实例的 SqlSessionFactory 了！

SqlSessionFactory

 

SqlSessionFactory 有六个方法建立 SqlSession 实例。一般来讲，当你选择这些方法时你须要考虑如下几点：

       
  • 事务处理：我须要在 session 使用事务或者使用自动提交功能（auto-commit）吗？（一般意味着不少数据库和/或 JDBC 驱动没有事务）
    •    
  • 链接：我须要依赖 MyBatis 得到来自数据源的配置吗？仍是使用本身提供的配置？
    •    
  • 执行语句：我须要 MyBatis 复用预处理语句和/或批量更新语句（包括插入和删除）吗？
 

基于以上需求，有下列已重载的多个 openSession() 方法供使用。

SqlSession openSession() SqlSession openSession(boolean autoCommit) SqlSession openSession(Connection connection) SqlSession openSession(TransactionIsolationLevel level) SqlSession openSession(ExecutorType execType,TransactionIsolationLevel level) SqlSession openSession(ExecutorType execType) SqlSession openSession(ExecutorType execType, boolean autoCommit) SqlSession openSession(ExecutorType execType, Connection connection) Configuration getConfiguration();
 

默认的 openSession()方法没有参数，它会建立有以下特性的 SqlSession：

       
  • 会开启一个事务（也就是不自动提交）。
    •    
  • 将从由当前环境配置的 DataSource 实例中获取 Connection 对象。
  • 事务隔离级别将会使用驱动或数据源的默认设置。
    •    
  • 预处理语句不会被复用，也不会批量处理更新。
 

这些方法大都是可读性强的。向 autoCommit 可选参数传递 true 值便可开启自动提交功能。若要使用本身的 Connection 实例，传递一个 Connection 实例给 connection 参数便可。注意并未覆写同时设置 Connection 和 autoCommit 二者的方法，由于 MyBatis 会使用正在使用中的、设置了 Connection 的环境。MyBatis 为事务隔离级别调用使用了一个 Java 枚举包装器，称为 TransactionIsolationLevel，若不使用它，将使用 JDBC 所支持五个隔离级（NONE、READ_UNCOMMITTED、READ_COMMITTED、REPEATABLE_READ 和 SERIALIZABLE），并按它们预期的方式来工做。

 

还有一个可能对你来讲是新见到的参数，就是 ExecutorType。这个枚举类型定义了三个值:  

       
  • ExecutorType.SIMPLE：这个执行器类型不作特殊的事情。它为每一个语句的执行建立一个新的预处理语句。
  • ExecutorType.REUSE：这个执行器类型会复用预处理语句。
    •    
  • ExecutorType.BATCH：这个执行器会批量执行全部更新语句，若是 SELECT 在它们中间执行，必要时请把它们区分开来以保证行为的易读性。
 

注意 在 SqlSessionFactory 中还有一个方法咱们没有说起，就是 getConfiguration()。这 个方法会返回一个 Configuration 实例，在运行时你可使用它来自检 MyBatis 的配置。  

 

注意 若是你使用的是 MyBatis 以前的版本，你要从新调用 openSession，由于旧版本的 session、事务和批量操做是分离开来的。若是使用的是新版本，那么就没必要这么作了，由于它们如今都包含在 session 的做用域内了。你没必要再单独处理事务或批量操做就能获得想要的所有效果。  

SqlSession

 

正如上面所提到的，SqlSession 实例在 MyBatis 中是很是强大的一个类。在这里你会看到全部执行语句、提交或回滚事务和获取映射器实例的方法。

 

在 SqlSession 类中有超过 20 个方法，因此将它们组合成易于理解的分组。

执行语句方法
 

这些方法被用来执行定义在 SQL 映射的 XML 文件中的 SELECT、INSERT、UPDATE 和 DELETE 语句。它们都会自行解释，每一句都使用语句的 ID 属性和参数对象，参数能够是原生类型（自动装箱或包装类）、JavaBean、POJO 或 Map。

<T> T selectOne(String statement, Object parameter) <E> List<E> selectList(String statement, Object parameter) <K,V> Map<K,V> selectMap(String statement, Object parameter, String mapKey) int insert(String statement, Object parameter) int update(String statement, Object parameter) int delete(String statement, Object parameter)
 

selectOne 和 selectList 的不一样仅仅是 selectOne 必须返回一个对象或 null 值。若是返回值多于一个，那么就会抛出异常。若是你不知道返回对象的数量，请使用 selectList。若是须要查看返回对象是否存在，可行的方案是返回一个值便可（0 或 1）。selectMap 稍微特殊一点，由于它会将返回的对象的其中一个属性做为 key 值，将对象做为 value 值，从而将多结果集转为 Map 类型值。由于并非全部语句都须要参数，因此这些方法都重载成不须要参数的形式。   

<T> T selectOne(String statement) <E> List<E> selectList(String statement) <K,V> Map<K,V> selectMap(String statement, String mapKey) int insert(String statement) int update(String statement) int delete(String statement)
 

最后，还有 select 方法的三个高级版本，它们容许你限制返回行数的范围，或者提供自定义结果控制逻辑，这一般在数据集合庞大的情形下使用。  

<E> List<E> selectList (String statement, Object parameter, RowBounds rowBounds) <K,V> Map<K,V> selectMap(String statement, Object parameter, String mapKey, RowBounds rowbounds) void select (String statement, Object parameter, ResultHandler<T> handler) void select (String statement, Object parameter, RowBounds rowBounds, ResultHandler<T> handler)
 

RowBounds 参数会告诉 MyBatis 略过指定数量的记录，还有限制返回结果的数量。RowBounds 类有一个构造方法来接收 offset 和 limit，另外，它们是不可二次赋值的。

int offset = 100; int limit = 25; RowBounds rowBounds = new RowBounds(offset, limit);
 

因此在这方面，不一样的驱动可以取得不一样级别的高效率。为了取得最佳的表现，请使用结果集的 SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 的类型(换句话说：不用 FORWARD_ONLY)。

 

ResultHandler 参数容许你按你喜欢的方式处理每一行。你能够将它添加到 List 中、建立 Map 和 Set，或者丢弃每一个返回值均可以，它取代了仅保留执行语句事后的总结果列表的死板结果。你可使用 ResultHandler 作不少事，而且这是 MyBatis 自身内部会使用的方法，以建立结果集列表。

Since 3.4.6, ResultHandler passed to a CALLABLE statement is used on every REFCURSOR output parameter of the stored procedure if there is any.

它的接口很简单。

package org.apache.ibatis.session; public interface ResultHandler<T> { void handleResult(ResultContext<? extends T> context); }

ResultContext 参数容许你访问结果对象自己、被建立的对象数目、以及返回值为 Boolean 的 stop 方法，你可使用此 stop 方法来中止 MyBatis 加载更多的结果。

 

使用 ResultHandler 的时候须要注意如下两种限制：

     
  • 从被 ResultHandler 调用的方法返回的数据不会被缓存。
    •  
  • 当使用结果映射集（resultMap）时，MyBatis 大多数状况下须要数行结果来构造外键对象。若是你正在使用 ResultHandler，你能够给出外键（association）或者集合（collection）还没有赋值的对象。
批量当即更新方法

有一个方法能够刷新（执行）存储在 JDBC 驱动类中的批量更新语句。当你将 ExecutorType.BATCH 做为 ExecutorType 使用时能够采用此方法。

List<BatchResult> flushStatements()
事务控制方法

控制事务做用域有四个方法。固然，若是你已经设置了自动提交或你正在使用外部事务管理器，这就没有任何效果了。然而，若是你正在使用 JDBC 事务管理器，由Connection 实例来控制，那么这四个方法就会派上用场：   

void commit() void commit(boolean force) void rollback() void rollback(boolean force)

默认状况下 MyBatis 不会自动提交事务，除非它侦测到有插入、更新或删除操做改变了数据库。若是你已经作出了一些改变而没有使用这些方法，那么你能够传递 true 值到 commit 和 rollback 方法来保证事务被正常处理（注意，在自动提交模式或者使用了外部事务管理器的状况下设置 force 值对 session 无效）。不少时候你不用调用 rollback()，由于 MyBatis 会在你没有调用 commit 时替你完成回滚操做。然而，若是你须要在支持多提交和回滚的 session 中得到更多细粒度控制，你可使用回滚操做来达到目的。

注意 MyBatis-Spring 和 MyBatis-Guice 提供了声明事务处理，因此若是你在使用 Mybatis 的同时使用了Spring 或者 Guice，那么请参考它们的手册以获取更多的内容。

 
本地缓存

Mybatis 使用到了两种缓存：本地缓存（local cache）和二级缓存（second level cache）。

每当一个新 session 被建立，MyBatis 就会建立一个与之相关联的本地缓存。任何在 session 执行过的查询语句自己都会被保存在本地缓存中，那么，相同的查询语句和相同的参数所产生的更改就不会二度影响数据库了。本地缓存会被增删改、提交事务、关闭事务以及关闭 session 所清空。

默认状况下，本地缓存数据可在整个 session 的周期内使用，这一缓存须要被用来解决循环引用错误和加快重复嵌套查询的速度，因此它能够不被禁用掉，可是你能够设置 localCacheScope=STATEMENT 表示缓存仅在语句执行时有效。

注意，若是 localCacheScope 被设置为 SESSION，那么 MyBatis 所返回的引用将传递给保存在本地缓存里的相同对象。对返回的对象（例如 list）作出任何更新将会影响本地缓存的内容，进而影响存活在 session 生命周期中的缓存所返回的值。所以，不要对 MyBatis 所返回的对象做出更改，以防后患。

你能够随时调用如下方法来清空本地缓存：

  
void clearCache()
确保 SqlSession 被关闭
void close()

你必须保证的最重要的事情是你要关闭所打开的任何 session。保证作到这点的最佳方式是下面的工做模式:

SqlSession session = sqlSessionFactory.openSession(); try { // following 3 lines pseudocod for "doing some work" session.insert(...); session.update(...); session.delete(...); session.commit(); } finally { session.close(); }

还有，若是你正在使用jdk 1.7以上的版本还有MyBatis 3.2以上的版本，你可使用try-with-resources语句：

try (SqlSession session = sqlSessionFactory.openSession()) { // following 3 lines pseudocode for "doing some work" session.insert(...); session.update(...); session.delete(...); session.commit(); }
 

注意 就像 SqlSessionFactory，你能够经过调用当前使用中的 SqlSession 的 getConfiguration 方法来得到 Configuration 实例。

Configuration getConfiguration()
使用映射器
<T> T getMapper(Class<T> type)

上述的各个 insert、update、delete 和 select 方法都很强大，但也有些繁琐，可能会产生类型安全问题而且对于你的 IDE 和单元测试也没有实质性的帮助。在上面的入门章节中咱们已经看到了一个使用映射器的示例。

所以，一个更通用的方式来执行映射语句是使用映射器类。一个映射器类就是一个仅需声明与 SqlSession 方法相匹配的方法的接口类。下面的示例展现了一些方法签名以及它们是如何映射到 SqlSession 上的。

public interface AuthorMapper { // (Author) selectOne("selectAuthor",5); Author selectAuthor(int id); // (List<Author>) selectList(“selectAuthors”) List<Author> selectAuthors(); // (Map<Integer,Author>) selectMap("selectAuthors", "id") @MapKey("id") Map<Integer, Author> selectAuthors(); // insert("insertAuthor", author) int insertAuthor(Author author); // updateAuthor("updateAuthor", author) int updateAuthor(Author author); // delete("deleteAuthor",5) int deleteAuthor(int id); }

总之，每一个映射器方法签名应该匹配相关联的 SqlSession 方法，而字符串参数 ID 无需匹配。相反，方法名必须匹配映射语句的 ID。

此外，返回类型必须匹配指望的结果类型，单返回值时为所指定类的值，多返回值时为数组或集合。全部经常使用的类型都是支持的，包括：原生类 型、Map、POJO 和 JavaBean。

 

注意 映射器接口不须要去实现任何接口或继承自任何类。只要方法能够被惟一标识对应的映射语句就能够了。

 

注意 映射器接口能够继承自其余接口。当使用 XML 来构建映射器接口时要保证语句被包含在合适的命名空间中。并且，惟一的限制就是你不能在两个继承关系的接口中拥有相同的方法签名（潜在的危险作法不可取）。

 

你能够传递多个参数给一个映射器方法。若是你这样作了，默认状况下它们将会以 "param" 字符串紧跟着它们在参数列表中的位置来命名，好比：#{param1}、#{param2}等。若是你想改变参数的名称（只在多参数状况下），那么你能够在参数上使用 @Param("paramName") 注解。

你也能够给方法传递一个 RowBounds 实例来限制查询结果。

映射器注解
 

由于最初设计时，MyBatis 是一个 XML 驱动的框架。配置信息是基于 XML 的，并且映射语句也是定义在 XML 中的。而到了 MyBatis 3，就有新选择了。MyBatis 3 构建在全面且强大的基于 Java 语言的配置 API 之上。这个配置 API 是基于 XML 的 MyBatis 配置的基础，也是新的基于注解配置的基础。注解提供了一种简单的方式来实现简单映射语句，而不会引入大量的开销。

 

注意 不幸的是，Java 注解的的表达力和灵活性十分有限。尽管不少时间都花在调查、设计和试验上，最强大的 MyBatis 映射并不能用注解来构建——并非在开玩笑，的确是这样。比方说，C#属性就没有这些限制，所以 MyBatis.NET 将会比 XML 有更丰富的选择。也就是说，基于 Java 注解的配置离不开它的特性。

 

注解以下表所示：

                                                                                                                                                       
注解 使用对象 相对应的 XML 描述
@CacheNamespace 类 <cache> 为给定的命名空间（好比类）配置缓存。属性有：implemetation, eviction, flushInterval, size, readWrite, blocking 和properties。
@Property N/A <property> 指定参数值或占位值（placeholder）（能被 mybatis-config.xml内的配置属性覆盖）。属性有：name, value。（仅在MyBatis 3.4.2以上版本生效）
@CacheNamespaceRef 类 <cacheRef> 参照另一个命名空间的缓存来使用。属性有：value, name。若是你使用了这个注解，你应设置 value 或者 name 属性的其中一个。value 属性用于指定 Java 类型而指定命名空间（命名空间名就是指定的 Java 类型的全限定名），name 属性（这个属性仅在MyBatis 3.4.2以上版本生效）直接指定了命名空间的名字。
@ConstructorArgs 方法 <constructor> 收集一组结果传递给一个结果对象的构造方法。属性有：value，它是形式参数数组。
@Arg N/A
  • <arg>
  • <idArg>
 单参数构造方法，是 ConstructorArgs 集合的一部分。属性有：id, column, javaType, jdbcType, typeHandler, select 和 resultMap。id 属性是布尔值，来标识用于比较的属性，和<idArg> XML 元素类似。
@TypeDiscriminator 方法 <discriminator> 一组实例值被用来决定结果映射的表现。属性有：column, javaType, jdbcType, typeHandler 和 cases。cases 属性是实例数组。
@Case N/A <case> 单独实例的值和它对应的映射。属性有：value, type, results。results 属性是结果数组，所以这个注解和实际的 ResultMap 很类似，由下面的 Results 注解指定。
@Results 方法 <resultMap> 结果映射的列表，包含了一个特别结果列如何被映射到属性或字段的详情。属性有：value, id。value 属性是 Result 注解的数组。这个 id 的属性是结果映射的名称。
@Result N/A
  • <result>
  • <id>
 在列和属性或字段之间的单独结果映射。属性有：id, column, javaType, jdbcType, typeHandler, one, many。id 属性是一个布尔值，来标识应该被用于比较（和在 XML 映射中的<id>类似）的属性。one 属性是单独的联系，和 <association> 类似，而 many 属性是对集合而言的，和<collection>类似。它们这样命名是为了不名称冲突。
@One N/A <association> 复杂类型的单独属性值映射。属性有：select，已映射语句（也就是映射器方法）的全限定名，它能够加载合适类型的实例。fetchType会覆盖全局的配置参数 lazyLoadingEnabled。注意 联合映射在注解 API中是不支持的。这是由于 Java 注解的限制,不容许循环引用。
@Many N/A <collection> 映射到复杂类型的集合属性。属性有：select，已映射语句（也就是映射器方法）的全限定名，它能够加载合适类型的实例的集合，fetchType 会覆盖全局的配置参数 lazyLoadingEnabled。注意 联合映射在注解 API中是不支持的。这是由于 Java 注解的限制，不容许循环引用
@MapKey 方法   这是一个用在返回值为 Map 的方法上的注解。它可以将存放对象的 List 转化为 key 值为对象的某一属性的 Map。属性有： value，填入的是对象的属性名，做为 Map 的 key 值。
@Options 方法 映射语句的属性 这个注解提供访问大范围的交换和配置选项的入口，它们一般在映射语句上做为属性出现。Options 注解提供了通俗易懂的方式来访问它们，而不是让每条语句注解变复杂。属性有：useCache=true, flushCache=FlushCachePolicy.DEFAULT, resultSetType=FORWARD_ONLY, statementType=PREPARED, fetchSize=-1, timeout=-1, useGeneratedKeys=false, keyProperty="id", keyColumn="", resultSets=""。值得一提的是， Java 注解没法指定 null 值。所以，一旦你使用了 Options 注解，你的语句就会被上述属性的默认值所影响。要注意避免默认值带来的预期之外的行为。
       注意： keyColumn 属性只在某些数据库中有效（如 Oracle、PostgreSQL等）。请在插入语句一节查看更多关于 keyColumn 和 keyProperty 二者的有效值详情。
  • @Insert
  • @Update
  • @Delete
  • @Select
 方法
  • <insert>
  • <update>
  • <delete>
  • <select>
 这四个注解分别表明将会被执行的 SQL 语句。它们用字符串数组（或单个字符串）做为参数。若是传递的是字符串数组，字符串之间先会被填充一个空格再链接成单个完整的字符串。这有效避免了以 Java 代码构建 SQL 语句时的“丢失空格”的问题。然而，你也能够提早手动链接好字符串。属性有：value，填入的值是用来组成单个 SQL 语句的字符串数组。
  • @InsertProvider
  • @UpdateProvider
  • @DeleteProvider
  • @SelectProvider
 方法
  • <insert>
  • <update>
  • <delete>
  • <select>
 容许构建动态 SQL。这些备选的 SQL 注解容许你指定类名和返回在运行时执行的 SQL 语句的方法。（自从MyBatis 3.4.6开始，你能够用 CharSequence 代替 String 来返回类型返回值了。）当执行映射语句的时候，MyBatis 会实例化类并执行方法，类和方法就是填入了注解的值。你能够把已经传递给映射方法了的对象做为参数，"Mapper interface type" 和 "Mapper method" 会通过 ProviderContext （仅在MyBatis 3.4.5及以上支持）做为参数值。（MyBatis 3.4及以上的版本，支持多参数传入）属性有： type, method。type 属性需填入类。method 需填入该类定义了的方法名。注意 接下来的小节将会讨论类，能帮助你更轻松地构建动态 SQL。
@Param 参数 N/A 若是你的映射方法的形参有多个，这个注解使用在映射方法的参数上就能为它们取自定义名字。若不给出自定义名字，多参数（不包括 RowBounds 参数）则先以 "param" 做前缀，再加上它们的参数位置做为参数别名。例如 #{param1}, #{param2}，这个是默认值。若是注解是 @Param("person")，那么参数就会被命名为 #{person}。
@SelectKey 方法 <selectKey> 这个注解的功能与 <selectKey> 标签彻底一致，用在已经被 @Insert 或 @InsertProvider 或 @Update 或 @UpdateProvider 注解了的方法上。若在未被上述四个注解的方法上做 @SelectKey 注解则视为无效。若是你指定了 @SelectKey 注解，那么 MyBatis 就会忽略掉由 @Options 注解所设置的生成主键或设置（configuration）属性。属性有：statement 填入将会被执行的 SQL 字符串数组，keyProperty 填入将会被更新的参数对象的属性的值，before 填入 true 或 false 以指明 SQL 语句应被在插入语句的以前仍是以后执行。resultType 填入 keyProperty 的 Java 类型和用 Statement、 PreparedStatement 和 CallableStatement 中的 STATEMENT、 PREPARED 或 CALLABLE 中任一值填入 statementType。默认值是 PREPARED。
@ResultMap 方法 N/A 这个注解给 @Select 或者 @SelectProvider 提供在 XML 映射中的 <resultMap> 的id。这使得注解的 select 能够复用那些定义在 XML 中的 ResultMap。若是同一 select 注解中还存在 @Results 或者 @ConstructorArgs，那么这两个注解将被此注解覆盖。
@ResultType 方法 N/A 此注解在使用告终果处理器的状况下使用。在这种状况下，返回类型为 void，因此 Mybatis 必须有一种方式决定对象的类型，用于构造每行数据。若是有 XML 的结果映射，请使用 @ResultMap 注解。若是结果类型在 XML 的 <select> 节点中指定了，就不须要其余的注解了。其余状况下则使用此注解。好比，若是 @Select 注解在一个将使用结果处理器的方法上，那么返回类型必须是 void 而且这个注解（或者@ResultMap）必选。这个注解仅在方法返回类型是 void 的状况下生效。
@Flush 方法 N/A 若是使用了这个注解，定义在 Mapper 接口中的方法可以调用 SqlSession#flushStatements() 方法。（Mybatis 3.3及以上）
映射申明样例

这个例子展现了如何使用 @SelectKey 注解来在插入前读取数据库序列的值：

@Insert("insert into table3 (id, name) values(#{nameId}, #{name})") @SelectKey(statement="call next value for TestSequence", keyProperty="nameId", before=true, resultType=int.class) int insertTable3(Name name);

这个例子展现了如何使用 @SelectKey 注解来在插入后读取数据库识别列的值：

@Insert("insert into table2 (name) values(#{name})") @SelectKey(statement="call identity()", keyProperty="nameId", before=false, resultType=int.class) int insertTable2(Name name);
 

这个例子展现了如何使用 @Flush 注解去调用 SqlSession#flushStatements()：

@Flush List<BatchResult> flush();

这些例子展现了如何经过指定 @Result 的 id 属性来命名结果集：

@Results(id = "userResult", value = { @Result(property = "id", column = "uid", id = true), @Result(property = "firstName", column = "first_name"), @Result(property = "lastName", column = "last_name") }) @Select("select * from users where id = #{id}") User getUserById(Integer id); @Results(id = "companyResults") @ConstructorArgs({ @Arg(property = "id", column = "cid", id = true), @Arg(property = "name", column = "name") }) @Select("select * from company where id = #{id}") Company getCompanyById(Integer id);
 

这个例子展现了单一参数使用 @SqlProvider 注解：

@SelectProvider(type = UserSqlBuilder.class, method = "buildGetUsersByName") List<User> getUsersByName(String name); class UserSqlBuilder { public static String buildGetUsersByName(final String name) { return new SQL(){{ SELECT("*"); FROM("users"); if (name != null) { WHERE("name like #{value} || '%'"); } ORDER_BY("id"); }}.toString(); } }
 

这个例子展现了多参数使用 @SqlProvider 注解：

@SelectProvider(type = UserSqlBuilder.class, method = "buildGetUsersByName") List<User> getUsersByName( @Param("name") String name, @Param("orderByColumn") String orderByColumn); class UserSqlBuilder { // If not use @Param, you should be define same arguments with mapper method public static String buildGetUsersByName( final String name, final String orderByColumn) { return new SQL(){{ SELECT("*"); FROM("users"); WHERE("name like #{name} || '%'"); ORDER_BY(orderByColumn); }}.toString(); } // If use @Param, you can define only arguments to be used public static String buildGetUsersByName(@Param("orderByColumn") final String orderByColumn) { return new SQL(){{ SELECT("*"); FROM("users"); WHERE("name like #{name} || '%'"); ORDER_BY(orderByColumn); }}.toString(); } }
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程