Mybatis
几个使用时的重要组件
SqlSessionFactoryBuilder
这个类可以被实例化、使用和丢弃,一旦创建了 SqlSessionFactory,就不再需要它了。因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域(也就是局部方法变量)。你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例,但是最好还是不要让其一直存在以保证所有的 XML 解析资源开放给更重要的事情。
SqlSessionFactory
SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在,没有任何理由对它进行清除或重建。使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次,多次重建 SqlSessionFactory 被视为一种代码“坏味道(bad smell)”。因此 SqlSessionFactory 的最佳作用域是应用作用域。有很多方法可以做到,最简单的就是使用单例模式或者静态单例模式。
SqlSession
每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域。绝对不能将 SqlSession 实例的引用放在一个类的静态域,甚至一个类的实例变量也不行。也绝不能将 SqlSession 实例的引用放在任何类型的管理作用域中,比如 Servlet 架构中的 HttpSession。如果你现在正在使用一种 Web 框架,要考虑 SqlSession 放在一个和 HTTP 请求对象相似的作用域中。换句话说,每次收到的 HTTP 请求,就可以打开一个 SqlSession,返回一个响应,就关闭它。这个关闭操作是很重要的,你应该把这个关闭操作放到 finally 块中以确保每次都能执行关闭。下面的示例就是一个确保 SqlSession 关闭的标准模式:
SqlSession session = sqlSessionFactory.openSession();
try {
// do work
} finally {
session.close();
}
映射器实例(Mapper Instances)
映射器是一个你创建来绑定你映射的语句的接口。映射器接口的实例是从 SqlSession 中获得的。因此从技术层面讲,任何映射器实例的最大作用域是和请求它们的 SqlSession 相同的。尽管如此,映射器实例的最佳作用域是方法作用域。也就是说,映射器实例应该在调用它们的方法中被请求,用过之后即可废弃。并不需要显式地关闭映射器实例,尽管在整个请求作用域(request scope)保持映射器实例也不会有什么问题,但是很快你会发现,像 SqlSession 一样,在这个作用域上管理太多的资源的话会难于控制。所以要保持简单,最好把映射器放在方法作用域(method scope)内。下面的示例就展示了这个实践:
SqlSession session = sqlSessionFactory.openSession();
try {
BlogMapper mapper = session.getMapper(BlogMapper.class);
// do work
} finally {
session.close();
}
配置文件
properties
这些属性都是可外部配置且可动态替换的,既可以在典型的 Java 属性文件中配置,亦可通过 properties 元素的子元素来传递。例如:
<properties resource="org/mybatis/example/config.properties">
<property name="username" value="dev_user"/>
<property name="password" value="F2Fa3!33TYyg"/>
</properties>
如果属性在不只一个地方进行了配置,那么 MyBatis 将按照下面的顺序来加载:
- 在 properties 元素体内指定的属性首先被读取。
- 然后根据 properties 元素中的 resource 属性读取类路径下属性文件或根据 url 属性指定的路径读取属性文件,并覆盖已读取的同名属性。
- 最后读取作为方法参数传递的属性,并覆盖已读取的同名属性。
因此,通过方法参数传递的属性具有最高优先级,resource/url 属性中指定的配置文件次之,最低优先级的是 properties 属性中指定的属性。
经过尝试确实是这样,如果resource配置文件里的属性会因为后读取而覆盖properties属性里指定的属性!
而方法传递的properties优先级最高.看下面这个例子:
public static SqlSessionFactory getSqlSessionFactory(String resource) throws Exception {
InputStream inputStream = Resources.getResourceAsStream(resource);
return new SqlSessionFactoryBuilder().build(inputStream, getProperties());
}
public static Properties getProperties() {
String driver = "com.mysql.cj.jdbc.Driver";
String username = "pinker";
String password = "*****";
String url = "jdbc:mysql://localhost:3306/cmb?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC";
Properties properties = new Properties();
properties.put("driver", driver);
properties.put("username", username);
properties.put("password", password);
properties.put("url", url);
return properties;
}
其实上面代码里的inputstream读取的配置文件里就有很全的配置属性,但是可以发现,这里我们动态地覆盖了它,这样是不是可以动态地切换数据库了,哈哈!
当然还有更后面的参数注入方法,并且覆盖我上面说的这个api-public SqlSessionFactory build(InputStream inputStream, Properties properties)
下面我们主要用到的api是:SqlSession openSession(Connection var1);
public void setUp() throws Exception {
SqlSessionFactory sqlSessionFactory = getSqlSessionFactory(resource);
String username = "pinker";
String password = "*****";
String url = "jdbc:mysql://localhost:3306/cmb?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC";
Connection connection = DriverManager.getConnection(url, username, password);
session = sqlSessionFactory.openSession(connection);
repo = session.getMapper(MonitorRepo.class);
}
正如我们所说,这个connection会覆盖上面所说的属性值.
typeAliases
有两种映射:
- 每个类单独映射(不常用)
- 整个包映射(常用!)
搭配@Alias
注解每一个在指定包中的 Java Bean,在没有注解的情况下,会使用 Bean 的首字母小写的非限定类名来作为它的别名。
下面表格是一些为常见的 Java 类型内建的相应的类型别名。它们都是大小写不敏感的,需要注意的是由基本类型名称重复导致的特殊处理。(可以发现我们不需要改变习惯!这个很棒!)
别名 | 映射的类型 |
---|---|
_byte | byte |
_long | long |
_short | short |
_int | int |
_integer | int |
_double | double |
_float | float |
_boolean | boolean |
string | String |
byte | Byte |
long | Long |
short | Short |
int | Integer |
integer | Integer |
double | Double |
float | Float |
boolean | Boolean |
date | Date |
decimal | BigDecimal |
bigdecimal | BigDecimal |
object | Object |
map | Map |
hashmap | HashMap |
list | List |
arraylist | ArrayList |
collection | Collection |
iterator | Iterator |
注解
public interface AnotationRepo {
@Select("select * from monitor")
@Results(value = {
@Result(property = "userName", column = "user_name"),
@Result(column = "did", property = "dbId"),
@Result(column = "pages_sec", property = "pagesPerSeconds"),
@Result(column = "ava_bytes", property = "avaliableBytes"),
@Result(column = "buffer_cache_ratio", property = "bufferCacheRatio"),
@Result(column = "current_connections", property = "connectionsNums"),
@Result(column = "cpu_ratio", property = "cpuRatio"),
@Result(column = "disk_ratio", property = "diskRation")
})
public List<MonitorInfo> queryInfo();
@UpdateProvider(type = MySQLProvider.class, method = "updateList")
public int updateMonitorInfo(MonitorInfo info);
}
ISSUE
-
错误: org.xml.sax.SAXParseException; lineNumber: 34; columnNumber: 17; 元素类型为 "configuration" 的内容必须匹配 。或者再配置文件里IDEA会显示错误
原因:在配置mybatis-config.xml时,其中的节点是有顺序的,配置顺序依次为:
properties/settings/typeAliases/typeHandlers/objectFactory/objectWrapperFactory/plugins/environments/databaseIdProvider/mappers