MyBatis
1、CURD
1、namespace
mapper.xml下面的namespace中的包名必须与对应mapper接口的包名一致!
2、select
选择,查询语句:
- id :对应namespace中的方法名
- parameterType:方法的参数类型
- resultType:sql执行后的返回值
- 添加接口中对应方法
//根据ID查询用户 User getUserById(int id);
- 编写对应mapper.xml里面的sql语句
<select id="getUserById" parameterType="int" resultType="com.jiutong.pojo.User"> select * from myBatis.user where id = #{id} </select>
- 测试
@Test public void getUserById(){ SqlSession sqlSession = MybatisUtils.getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); User userById = mapper.getUserById(1); System.out.println(userById); sqlSession.close(); }
3、insert
- 添加接口中对应方法
//inset用户 int addUser(User user);
- 编写对应mapper.xml里面的sql语句
<!--连接了数据库后,myBatis.user()可以直接得到里面的字段--> <!--对象中的属性可以直接取出来--> <insert id="addUser" parameterType="com.jiutong.pojo.User"> insert into myBatis.user(id, name, pwd) values (#{id},#{name},#{pwd}) </insert>
- 测试
//增删改需要提交事务 @Test public void addUser(){ SqlSession sqlSession = MybatisUtils.getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); mapper.addUser(new User(4,"码字","123456")); //提交事务 sqlSession.commit(); sqlSession.close(); }
4、update
- 添加接口中对应方法
//修改用户 int updateUser(User user);
- 编写对应mapper.xml里面的sql语句
<!-- 使用 upd 可以快速生成--> <update id="updateUser" parameterType="com.jiutong.pojo.User"> update myBatis.user set name = #{name},pwd=#{pwd} where id=#{id}; </update>
- 测试
@Test public void updateUser(){ SqlSession sqlSession = MybatisUtils.getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); mapper.updateUser(new User(4,"赫赫","654321")); //提交事务 sqlSession.commit(); sqlSession.close(); }
5、delete
- 添加接口中对应方法
//删除用户 int deleteUser(int id);
- 编写对应mapper.xml里面的sql语句
<delete id="deleteUser" parameterType="int"> delete from myBatis.user where id = #{id} </delete>
- 测试
@Test public void deleteUser(){ SqlSession sqlSession = MybatisUtils.getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); mapper.deleteUser(4); //提交事务 sqlSession.commit(); sqlSession.close(); }
6、可能遇到的问题
Caused by: org.apache.ibatis.exceptions.PersistenceException:
### Error building SqlSession.
### The error may exist in com/jiutong/dao/UserMapper.xml
### Cause: org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration. Cause: org.apache.ibatis.builder.BuilderException: Error creating document instance. Cause: com.sun.org.apache.xerces.internal.impl.io.MalformedByteSequenceException: 1 字节的 UTF-8 序列的字节 1 无效。
输出的XML文件中存在乱码问题
target/classes/com/jiutong/dao/UserMapper.xml下面
解决办法:
- **(不推荐)**将Mapper.Xml里面的
<?xml version="1.0" encoding="UTF-8" ?>
修改成<?xml version="1.0" encoding="UTF8" ?>
- **(推荐)**打开设置(Settiongs)-文本编码(File Encofings) 将Project Encoding修改成 UTF-8。修改后删除target文件重新测试
7、用Map来处理insert
- 添加接口中对应方法
//Map对象 //通过map对象插入一个User int addUserByMap(Map<String,Object> map);
- 编写对应mapper.xml里面的sql语句
<insert id="addUserByMap" parameterType="map"> insert into myBatis.user(id, name, pwd) values (#{mapid},#{mapname},#{mappwd}) </insert>
- 测试
//通过map来处理 @Test public void addUserByMap(){ SqlSession sqlSession = MybatisUtils.getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); Map<String,Object> map=new HashMap<String, Object>(); map.put("mapid",5); map.put("mapname","map"); map.put("mappwd","567"); mapper.addUserByMap(map); //提交事务 sqlSession.commit(); sqlSession.close(); }
2、配置解析
2.1、核心配置文件
- 官方名称:mybatis-config.xml
- MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。 配置文档的顶层结构如下:
configuration(配置) properties(属性) settings(设置) typeAliases(类型别名) typeHandlers(类型处理器) objectFactory(对象工厂) plugins(插件) environments(环境配置) environment(环境变量) transactionManager(事务管理器) dataSource(数据源) databaseIdProvider(数据库厂商标识) mappers(映射器)
2.2、环境配置(environments)
Mybatis可以配置成适应多种环境
不过要记住:尽管可以配置多个环境,但每个 SqlSessionFactory 实例只能选择一种环境。
配置多套运行环境
Mybatis默认的事务管理器就是JDBC,连接池POOLED
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<!--configuration核心配置文件-->
<configuration>
<!--环境,default为默认环境-->
<environments default="development">
<!--第一套环境-->
<environment id="development">
<!--在 MyBatis 中有两种类型的事务管理器(也就是 type="[JDBC|MANAGED]")-->
<transactionManager type="JDBC"/>
<!--有三种内建的数据源类型(也就是 type="[UNPOOLED|POOLED|JNDI]"):-->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://192.168.4.108:3306/myBatis?useSSL=false&useUnicode=true&characterEncoding=UTF-8"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
<!--第二套环境-->
<environment id="test">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://192.168.4.108:3306/myBatis?useSSL=false&useUnicode=true&characterEncoding=UTF-8"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com/jiutong/dao/UserMapper.xml"/>
</mappers>
</configuration>
2.3、properties(属性)
我们可以通过properties属性来实现引用配置文件
这些属性可以在外部进行配置,并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性,也可以在 properties 元素的子元素中设置。
- 编写一个数据库配置文件[db.properties]//和mybatis-config.xml同级
driver=com.mysql.jdbc.Driver url=jdbc:mysql://192.168.4.108:3306/myBatis?useSSL=false&useUnicode=true&characterEncoding=UTF-8 username=root password=root
- 修改mybatis-config.xml
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <!--configuration核心配置文件--> <configuration> <!--引入外部配置文件--> <properties resource="db.properties"/> <environments default="development"> <environment id="development"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <!--修改成引用--> <property name="driver" value="${driver}"/> <property name="url" value="${url}"/> <property name="username" value="${username}"/> <property name="password" value="${password}"/> </dataSource> </environment> </environments> <mappers> <mapper resource="com/jiutong/dao/UserMapper.xml"/> </mappers> </configuration>
- 可以直接引入外部文件
- 可以在其中增加一些属性配置
<properties resource="db.properties"> <property name="username" value="dev_user"/> <property name="password" value="F2Fa3!33TYyg"/> </properties>
- 如果两个文件都有同一个字段,优先读取外部
比如外部文件中
username=root
,而内部<property name="username" value="dev_user"/>
优先读取root - db.properties中转义符
&
可以直接写成&
- 另外由于configuration严格控制了每个结构的顺序,
properties
必须处于第一位置
2.4、类型别名(typeAliases)
- 类型别名可为 Java 类型设置一个缩写名字。
- 它仅用于 XML 配置,意在降低冗余的全限定类名书写。
<!--可以给实体类起一个别名-->
<typeAliases>
<typeAlias type="com.jiutong.pojo.User" alias="User"/>
</typeAliases>
也可以指定一个包名,MyBatis 会在包名下面搜索需要的 Java Bean,比如:
**在没有注解的情况下,会使用 Bean 的首字母小写的非限定类名来作为它的别名。**我发现并不是这样,只要是字母相同就可以识别
<!--扫描一个包下面的pojo-->
<typeAliases>
<package name="com.jiutong.pojo"/>
</typeAliases>
在实体类比较少的时候,使用第一种。
如果实体类十分多,建议使用第二种。
第一种可以DIY给别名,第二种可以使用注解来实现DIY。
下面是一些为常见的 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 |
可以看出来所有的基本类型的别名都是_XXX
2.5、设置(settings)
这是 MyBatis 中极为重要的调整设置,它们会改变 MyBatis 的运行时行为。 下表描述了设置中各项设置的含义、默认值等。
设置名 | 描述 | 有效值 | 默认值 |
---|---|---|---|
cacheEnabled | 全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。 | true | false | true |
lazyLoadingEnabled | 延迟加载的全局开关。当开启时,所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。 |
true | false | false |
aggressiveLazyLoading | 开启时,任一方法的调用都会加载该对象的所有延迟加载属性。 否则,每个延迟加载属性会按需加载(参考 lazyLoadTriggerMethods )。 |
true | false | false (在 3.4.1 及之前的版本中默认为 true) |
multipleResultSetsEnabled | 是否允许单个语句返回多结果集(需要数据库驱动支持)。 | true | false | true |
useColumnLabel | 使用列标签代替列名。实际表现依赖于数据库驱动,具体可参考数据库驱动的相关文档,或通过对比测试来观察。 | true | false | true |
useGeneratedKeys | 允许 JDBC 支持自动生成主键,需要数据库驱动支持。如果设置为 true,将强制使用自动生成主键。尽管一些数据库驱动不支持此特性,但仍可正常工作(如 Derby)。 | true | false | False |
autoMappingBehavior | 指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示关闭自动映射;PARTIAL 只会自动映射没有定义嵌套结果映射的字段。 FULL 会自动映射任何复杂的结果集(无论是否嵌套)。 | NONE, PARTIAL, FULL | PARTIAL |
autoMappingUnknownColumnBehavior | 指定发现自动映射目标未知列(或未知属性类型)的行为。NONE : 不做任何反应WARNING : 输出警告日志(‘org.apache.ibatis.session.AutoMappingUnknownColumnBehavior‘ 的日志等级必须设置为 WARN )FAILING : 映射失败 (抛出 SqlSessionException ) |
NONE, WARNING, FAILING | NONE |
defaultExecutorType | 配置默认的执行器。SIMPLE 就是普通的执行器;REUSE 执行器会重用预处理语句(PreparedStatement); BATCH 执行器不仅重用语句还会执行批量更新。 | SIMPLE REUSE BATCH | SIMPLE |
defaultStatementTimeout | 设置超时时间,它决定数据库驱动等待数据库响应的秒数。 | 任意正整数 | 未设置 (null) |
defaultFetchSize | 为驱动的结果集获取数量(fetchSize)设置一个建议值。此参数只可以在查询设置中被覆盖。 | 任意正整数 | 未设置 (null) |
defaultResultSetType | 指定语句默认的滚动策略。(新增于 3.5.2) | FORWARD_ONLY | SCROLL_SENSITIVE | SCROLL_INSENSITIVE | DEFAULT(等同于未设置) | 未设置 (null) |
safeRowBoundsEnabled | 是否允许在嵌套语句中使用分页(RowBounds)。如果允许使用则设置为 false。 | true | false | False |
safeResultHandlerEnabled | 是否允许在嵌套语句中使用结果处理器(ResultHandler)。如果允许使用则设置为 false。 | true | false | True |
mapUnderscoreToCamelCase | 是否开启驼峰命名自动映射,即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。 | true | false | False |
localCacheScope | MyBatis 利用本地缓存机制(Local Cache)防止循环引用和加速重复的嵌套查询。 默认值为 SESSION,会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT,本地缓存将仅用于执行语句,对相同 SqlSession 的不同查询将不会进行缓存。 | SESSION | STATEMENT | SESSION |
jdbcTypeForNull | 当没有为参数指定特定的 JDBC 类型时,空值的默认 JDBC 类型。 某些数据库驱动需要指定列的 JDBC 类型,多数情况直接用一般类型即可,比如 NULL、VARCHAR 或 OTHER。 | JdbcType 常量,常用值:NULL、VARCHAR 或 OTHER。 | OTHER |
lazyLoadTriggerMethods | 指定对象的哪些方法触发一次延迟加载。 | 用逗号分隔的方法列表。 | equals,clone,hashCode,toString |
defaultScriptingLanguage | 指定动态 SQL 生成使用的默认脚本语言。 | 一个类型别名或全限定类名。 | org.apache.ibatis.scripting.xmltags.XMLLanguageDriver |
defaultEnumTypeHandler | 指定 Enum 使用的默认 TypeHandler 。(新增于 3.4.5) |
一个类型别名或全限定类名。 | org.apache.ibatis.type.EnumTypeHandler |
callSettersOnNulls | 指定当结果集中值为 null 的时候是否调用映射对象的 setter(map 对象时为 put)方法,这在依赖于 Map.keySet() 或 null 值进行初始化时比较有用。注意基本类型(int、boolean 等)是不能设置成 null 的。 | true | false | false |
returnInstanceForEmptyRow | 当返回行的所有列都是空时,MyBatis默认返回 null 。 当开启这个设置时,MyBatis会返回一个空实例。 请注意,它也适用于嵌套的结果集(如集合或关联)。(新增于 3.4.2) |
true | false | false |
logPrefix | 指定 MyBatis 增加到日志名称的前缀。 | 任何字符串 | 未设置 |
logImpl | 指定 MyBatis 所用日志的具体实现,未指定时将自动查找。 | SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING | 未设置 |
proxyFactory | 指定 Mybatis 创建可延迟加载对象所用到的代理工具。 | CGLIB | JAVASSIST | JAVASSIST (MyBatis 3.3 以上) |
vfsImpl | 指定 VFS 的实现 | 自定义 VFS 的实现的类全限定名,以逗号分隔。 | 未设置 |
useActualParamName | 允许使用方法签名中的名称作为语句参数名称。 为了使用该特性,你的项目必须采用 Java 8 编译,并且加上 -parameters 选项。(新增于 3.4.1) |
true | false | true |
configurationFactory | 指定一个提供 Configuration 实例的类。 这个被返回的 Configuration 实例用来加载被反序列化对象的延迟加载属性值。 这个类必须包含一个签名为static Configuration getConfiguration() 的方法。(新增于 3.2.3) |
一个类型别名或完全限定类名。 | 未设置 |
2.6、其他配置
-
类型处理器(typeHandlers)
-
对象工厂(objectFactory)
-
插件(plugins)
- mybatis-generator-core
- mybatis-plus
- 通用mapper
2.7、映射器(mappers)
方法一:使用相对于类路径的资源引用
<mappers>
<mapper resource="com/jiutong/dao/UserMapper.xml"/>
</mappers>
方法二:使用映射器接口实现类的完全限定类名
<mappers>
<mapper class="com.jiutong.dao.UserMapper"/>
</mappers>
注意点:
- 接口和它的Mapper配置文件必须同名
- 接口和它的Mapper配置文件必须在同一个包下
方法三:将包内的映射器接口实现全部注册为映射器
<mappers>
<package name="com.jiutong.dao"/>
</mappers>
注意点:
- 接口和它的Mapper配置文件必须同名
- 接口和它的Mapper配置文件必须在同一个包下
方法四:使用完全限定资源定位符(URL)不建议使用
<mappers>
<mapper url="file:///var/mappers/AuthorMapper.xml"/>
<mapper url="file:///var/mappers/BlogMapper.xml"/>
<mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>
3、生命周期和作用域
作用域和生命周期类别是至关重要的,因为错误的使用会导致非常严重的并发问题。
SqlSessionFactoryBuilder:
- 一旦创建了 SqlSessionFactory,就不再需要它了
- 局部方法变量
SqlSessionFactory:
- 可以理解成:数据库连接池
- SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在,没有任何理由丢弃它或重新创建另一个实例。
- 因此 SqlSessionFactory 的最佳作用域是应用作用域
- 最简单的就是使用单例模式或者静态单例模式
SqlSession:
- 可以理解成:连接池的一个请求
- qlSession 的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域
- 用完就立即关闭
原文地址:https://www.cnblogs.com/lvsafe/p/12556509.html