第一个MyBatis程序

在创建 MyBatis 项目之前,首先创建 website 数据表,SQL 语句如下。

  • DROP TABLE IF EXISTS `website`;
  • CREATE TABLE `website` (
  • `id` int(11) NOT NULL AUTO_INCREMENT,
  • `name` varchar(20) COLLATE utf8_unicode_ci NOT NULL,
  • `url` varchar(30) COLLATE utf8_unicode_ci DEFAULT ,
  • `age` tinyint(3) unsigned NOT NULL,
  • `country` char(3) COLLATE utf8_unicode_ci NOT NULL DEFAULT ,
  • `createtime` timestamp NULL DEFAULT NULL,
  • PRIMARY KEY (`id`)
  • ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

创建 MyBatis 程序的步骤为:下载jar包 -> 部署jar包 -> 编写MyBatis核心配置文件 -> 创建实体类 -> 创建DAO接口 -> 创建SQL映射文件 -> 编写测试类

下面介绍如何使用 Eclipse IDE 创建一个简单的 MyBatis 程序。

1. 创建Web应用,部署jar包

在 Eclipse 中创建 Web 项目 mybatisDemo,并将下载的 MyBatis 的核心 jar 包、依赖 jar 包以及 MySQL 数据库的驱动 jar 包复制到 /WEB-INF/lib 目录中。下载jar包详细步骤在《MyBatis下载》一节讲解。

2. 创建日志文件

MyBatis 默认使用 log4j 输出日志信息,如果开发者需要查看控制台输出的 SQL 语句,可以在 classpath 路径下配置其日志文件。在 mybatisDemo 的 src 目录下创建 log4j.properties 文件,其内容如下:

# Global logging configuration
log4j.rootLogger=ERROR,stdout
# MyBatis logging configuration…
log4j.logger.net.biancheng=DEBUG
# Console output…
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] – %m%n

在日志文件中配置了全局的日志配置、MyBatis 的日志配置和控制台输出,其中 MyBatis 的日志配置用于将 net.biancheng 包下所有类的日志记录级别设置为 DEBUG。该配置文件内容不需要开发者全部手写,可以从 MyBatis 使用手册中的 Logging 小节复制,然后进行简单修改。

3. 创建持久化类

在 src 目录下创建一个名为 net.biancheng.po 的包,在该包中创建持久化类 Website。注意,在类中声明的属性与数据表 website 的字段一致。

Website 类代码如下。

  1. package net.biancheng.po;
  2. import java.util.Date;
  3. public class Website {
  4. private int id;
  5. private String name;
  6. private String url;
  7. private int age;
  8. private String country;
  9. private Date createtime;
  10. /*省略setter和getter方法*/
  11. @Override
  12. public String toString() {
  13. return “id” + id + “name” + name + “url” + url + “age” + age + “country” + country + “createtime” + createtime;
  14. }
  15. }

4. 创建映射文件

在 src 目录下创建 net.biancheng.mapper 包,在该包下创建映射文件 WebsiteMapper.xml。

WebsiteMapper.xml 文件内容如下。

  1. <?xml version=“1.0” encoding=“UTF-8”?>
  2. <!DOCTYPE mapper
  3. PUBLIC “-//mybatis.org//DTD Mapper 3.0//EN”
  4. “http://mybatis.org/dtd/mybatis-3-mapper.dtd”>
  5. <mapper namespace=“net.biancheng.mapper.WebsiteMapper”>
  6. <!– 添加一个网站 –>
  7. <insert id=“addWebsite” parameterType=“net.biancheng.po.Website”>
  8. insert into website
  9. (name,url,age,country)
  10. values(#{name},#{url},#{age},#{country})
  11. </insert>
  12. <!– 查询所有网站信息 –>
  13. <select id=“selectAllWebsite”
  14. resultType=“net.biancheng.po.Website”>
  15. select * from website
  16. </select>
  17. </mapper>

上述代码中,<mapper> 元素是配置文件的根元素,它包含了 namespace 属性,该属性值通常设置为“包名+SQL映射文件名”,用于指定唯一的命名空间。

子元素 <select>、<insert> 中的信息用于执行查询、添加操作。在定义的 SQL 语句中,“#{}”表示一个占位符,相当于“?”,而“#{name}”表示该占位符待接收参数的名称为 name。

5. 创建配置文件

MyBatis 核心配置文件主要用于配置数据库连接和 MyBatis 运行时所需的各种特性,包含了设置和影响 MyBatis 行为的属性。

在 src 目录下创建 MyBatis 的核心配置文件 mybatis-config.xml,在该文件中配置了数据库环境和映射文件的位置,具体内容如下:

  1. <?xml version=“1.0” encoding=“UTF-8”?>
  2. <!DOCTYPE configuration PUBLIC “-//mybatis.org//DTD Config 3.0//EN”
  3. “http://mybatis.org/dtd/mybatis-3-config.dtd”>
  4. <configuration>
  5. <settings>
  6. <setting name=“logImpl” value=“LOG4J” />
  7. </settings>
  8. <!– 配置mybatis运行环境 –>
  9. <environments default=“development”>
  10. <environment id=“development”>
  11. <!– 使用JDBC的事务管理 –>
  12. <transactionManager type=“JDBC” />
  13. <dataSource type=“POOLED”>
  14. <!– MySQL数据库驱动 –>
  15. <property name=“driver” value=“com.mysql.jdbc.Driver” />
  16. <!– 连接数据库的URL –>
  17. <property name=“url”
  18. value=“jdbc:mysql://localhost:3306/test?characterEncoding=utf8” />
  19. <property name=“username” value=“root” />
  20. <property name=“password” value=“root” />
  21. </dataSource>
  22. </environment>
  23. </environments>
  24. <!– 将mapper文件加入到配置文件中 –>
  25. <mappers>
  26. <mapper resource=“net/biancheng/mapper/WebsiteMapper.xml” />
  27. </mappers>
  28. </configuration>

上述映射文件和配置文件都不需要读者完全手动编写,都可以从 MyBatis 使用手册中复制,然后做简单修改。

为了方便管理以后各框架集成所需的配置文件,可以在项目工程下新建 Source Folder 类型的 resources 目录,并在此目录下添加 MyBatis 的核心配置文件,默认文件名为 ” configuration.xml”。但需要注意的是,为了方便在框架集成时更好地区分各个配置文件,我们一般将此文件名命名“mybatis-config.xml”,该文件用于配置数据库连接信息和 MyBatis 的参数。

6. 创建测试类

在 src 目录下创建一个名为 net.biancheng.test 的包,在该包中创建 MyBatisTest 测试类。在测试类中首先使用输入流读取配置文件,然后根据配置信息构建 SqlSessionFactory 对象。

接下来通过 SqlSessionFactory 对象创建 SqlSession 对象,并使用 SqlSession 对象的方法执行数据库操作。 MyBatisTest 测试类的代码如下:

  1. package net.biancheng.test;
  2. import java.io.IOException;
  3. import java.io.InputStream;
  4. import java.util.List;
  5. import org.apache.ibatis.io.Resources;
  6. import org.apache.ibatis.session.SqlSession;
  7. import org.apache.ibatis.session.SqlSessionFactory;
  8. import org.apache.ibatis.session.SqlSessionFactoryBuilder;
  9. import net.biancheng.po.Website;
  10. public class Test {
  11. public static void main(String[] args) throws IOException {
  12. // 读取配置文件mybatis-config.xml
  13. InputStream config = Resources.getResourceAsStream(“mybatis-config.xml”);
  14. // 根据配置文件构建SqlSessionFactory
  15. SqlSessionFactory ssf = new SqlSessionFactoryBuilder().build(config);
  16. // 通过SqlSessionFactory创建SqlSession
  17. SqlSession ss = ssf.openSession();
  18. // SqlSession执行文件中定义的SQL,并返回映射结果
  19. // 添加网站
  20. Website website = new Website();
  21. website.setName(“编程帮”);
  22. website.setUrl(“https://www.biancheng.net/”);
  23. website.setAge(21);
  24. website.setCountry(“CN”);
  25. ss.insert(“net.biancheng.mapper.WebsiteMapper.addWebsite”, website);
  26. // 查询所有网站
  27. List<Website> listWeb = ss.selectList(“net.biancheng.mapper.WebsiteMapper.selectAllWebsite”);
  28. for (Website site : listWeb) {
  29. System.out.println(site);
  30. }
  31. // 提交事务
  32. ss.commit();
  33. // 关闭 SqlSession
  34. ss.close();
  35. }
  36. }

运行结果如下。

DEBUG [main] – ==>  Preparing: insert into website (name,url,age,country) values(?,?,?,?)
DEBUG [main] – ==> Parameters: 编程帮(String), https://www.biancheng.net/(String), 21(Integer), CN(String)
DEBUG [main] – <==    Updates: 1
DEBUG [main] – ==>  Preparing: select * from website
DEBUG [main] – ==> Parameters:
DEBUG [main] – <==      Total: 1
Website[id=1,name=编程帮,url=https://www.biancheng.net/,age=21,country=CN,createtime=Tue Feb 23 10:20:40 CST 2021]

原创文章,作者:奋斗,如若转载,请注明出处:https://blog.ytso.com/24145.html

(0)
上一篇 2021年7月20日
下一篇 2021年7月21日

相关推荐

发表回复

登录后才能评论