Java框架 Mybatis入门笔记一 简单CRUD [使用Maven管理项目] (附代码)

之前学过了一个ORM框架是Hibernate 还是很好用的… 现在学一个国内用的比较多的ORM框架, Mybatis

首先, 这个Mybatis也是一个ORM框架, 用于简化数据库操作的;

这一次我使用Maven来管理这个项目…也正是因为这个尝试浪费了接近一天的时间…

首先, 从头开始, 我的环境是macOS High Sierra 10.13.5 (17F77) + java 1.8 + idea

本文中所实现的所有代码已经打包上传, 有需要的朋友可以自行下载~
地址:Mybatis的Demo文件打包 使用Maven管理 如果没有CSDN积分的可以评论或者私信我邮箱 我发给你

首先在idea中创建一个maven项目, 然后选择:

然后随便命个名, 无脑下一步之后:
然后我们会得到一个类似这样的目录:

这里我已经创建了一些文件夹, 这个是Maven的标准目录, 一般在main.java中放所有的java代码, 然后在resources中放所有的静态资源和一些配置文件;

可以发现最下面有一个pom.xml这个就是maven的配置文件了, 我的配置文件大概是这样的:

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0modelVersion>

    <groupId>com.zpwgroupId>
    <artifactId>com.zpwartifactId>
    <version>1.0-SNAPSHOTversion>

    <dependencies>
        <dependency>
            <groupId>mysqlgroupId>
            <artifactId>mysql-connector-javaartifactId>
            <version>8.0.15version>
        dependency>
        
        <dependency>
            <groupId>org.mybatisgroupId>
            <artifactId>mybatisartifactId>
            <version>3.5.0version>
        dependency>
    dependencies>

    <build>
        <resources>
            <resource>
                <directory>src/main/javadirectory>
                <includes>
                    <include>**/*.xmlinclude>
                includes>
                <filtering>falsefiltering>
            resource>
        resources>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.pluginsgroupId>
                <artifactId>maven-compiler-pluginartifactId>
                <version>3.8.0version>
                <configuration>
                    <source>1.8source>
                    <target>1.8target>
                configuration>
            plugin>
        plugins>
    build>
    
project>

大概讲一下这是什么意思, 做maven的配置主要就是在dependencies标签下写dependency, 把需要导入的包写进来就可以了, 然后maven会自动去下载这些包到本地仓库, 就可以用了;

那么去那里找这些maven的包呢, 推荐一个网址: https://mvnrepository.com/
可以去这里面找需要的包, 比如我们这里需要导入mybatis包, 那么我就在里面搜索mybatis, 然后我就选了第一个
然后选择一个版本之后, 在里面可以找到用于maven的dependency代码:
直接复制到pom.xml中用就可以了;

然后我解释一下我这里的build标签里的内容, 第一段等会儿再说(这里可以先删掉, 等会儿需要的时候再写), 第二段

        <plugins>
            <plugin>
                <groupId>org.apache.maven.pluginsgroupId>
                <artifactId>maven-compiler-pluginartifactId>
                <version>3.8.0version>
                <configuration>
                    <source>1.8source>
                    <target>1.8target>
                configuration>
            plugin>
        plugins>

这里是使用一个plugin为了指定java的jre的版本是java8, 因为maven默认会使用1.5版本的java, 而且每次新导入包之后都会恢复默认设置, 所以使用这段代码强制让maven使用java1.8版本;

然后开始写mybatis相关的代码:

首先, 和hibernate一样, 要写一个配置文件, 命名为mybatis-config.xml然后我的配置如下:

<configuration>
    <typeAliases>
        <package name="pojo" />
    typeAliases>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC" />
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/demo"/>
                <property name="username" value="zpw"/>
                <property name="password" value="ciscocisco"/>
            dataSource>
        environment>
    environments>
    
    <mappers>
        <mapper resource="mapper/Category.xml"  />
        <package name="pojo" />
    mappers>

configuration>

然后讲一下这个配置是什么意思, 第一段设置别名, 这个后面会用到

第二段设置环境和事务管理器这些都是常规操作, 都差不多;

第三段设置数据源中根据需要设置对应的数据库信息即可;

最后一段是对mappers的配置, 这里有一个很坑的点, 我马上讲;

然后我们先建一个实体类, 创建一个包叫pojo, 然后建一个Category类:

package pojo;

public class Category {
    private int id;
    private String name;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

然后再建一个包叫mapper专门存放数据库和实体类的映射配置, 新建一个xml文件叫Category.xml, 模板配置如下:

<mapper namespace="pojo">

mapper>

然后我们可以开始写配置信息了, 比如我希望提供一个查询操作, 能提供查询到所有的category_表中的数据, 可以这么写, 写在mapper标签里面:

<mapper namespace="pojo">
	<select id="listCategory" resultType="Category">
        select * from category_
    select>
mapper>

这个意思就是, 我要提供一个select的功能, 标志id为listCategory, 然后返回值的条目是Category类型的, 使用的查询语句是select * from category_

然后到这里我讲一下前面说的大坑是什么意思…

首先, 在mybatis-config.xml文件的mappers的配置中, 我是这么写的:

    <mappers>
        <mapper resource="mapper/Category.xml"  />
        <package name="pojo" />
    mappers>

这里是指定了我的mapper的资源路径, 如果没有在这里指定的话, 会默认去resources目录下找, 然后指定这个配置资源对应的实体类的包路径是在pojo里面的, 要注意这里写路径要用/来写, 不能用.
如果这里我只指定了mapper的资源路径, 不指定package的路径, 那么会自动去配置文件的目录下寻找实体类;

然后我使用了别名

	<typeAliases>
        <package name="pojo" />
    typeAliases>

所以在我的具体配置文件Category.xml中 比如我写resultType="Category"的时候, 我就不需要写pojo.Category了, 可以直接写Category

然后在maven的配置文件中我写了这样一段:

	<resources>
            <resource>
                <directory>src/main/javadirectory>
                <includes>
                    <include>**/*.xmlinclude>
                includes>
                <filtering>falsefiltering>
            resource>
        resources>

这是因为默认在maven的文件结构下, maven会默认去resources目录下来加载配置文件, 但是我们的Category.xml文件并不放在resources里面, 而是放在了指定目录下, main.java.mapper目录, 默认情况下, maven不会加载除了resources目录下的其他资源和配置文件, 所以我们需要告诉maven去include来加载src/main/java目录下的xml配置文件;

然后测试的时候, 我们可以这样来测试之前写的listCategory功能:

import java.io.IOException;
import java.io.InputStream;
import java.util.List;
 
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class Test {

	public static void main(String[] args) throws IOException {
		String resource = "mybatis-config.xml";
		InputStream inputStream = Resources.getResourceAsStream(resource);
		SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        SqlSession session=sqlSessionFactory.openSession();
        
        List<Category> cs=session.selectList("listCategory");
        for (Category c : cs) {
			System.out.println(c.getName());
		}
		
	}
}

这里在使用selectlist方法的时候提供的这个字符串参数, 就是之前我们设置的id, 然后我们就成功获取到了所有的Category的list;

不过在此之前别忘了去数据库中创建一个category_的表:

然后讲一下用mybatis实现的增删改查功能:
首先是Category.xml配置信息:

我的完整配置信息如下:

<mapper namespace="pojo">
    <select id="listCategory" resultType="Category">
        select * from category_
    select>

    <insert id="addCategory" parameterType="Category">
        insert into category_(name) value (#{name})
    insert>

    <delete id="deleteCategory" parameterType="Category">
        delete from category_ where id= #{id}
    delete>

    <update id="updateCategory" parameterType="Category">
        update category_ set name=#{name} where id=#{id}
    update>
    
    <select id="getCategory" parameterType="java.lang.Integer" resultType="Category">
        select * from category_ where id=#{id}
    select>

    <select id="getCategoryByIdAndName" parameterType="Map" resultType="Category">
        select * from category_ where id>=#{id} and name like concat('%',#{name}, '%')
    select>
mapper>

以查询为例:

	<select id="getCategory" parameterType="java.lang.Integer" resultType="Category">
        select * from category_ where id=#{id}
    select>

这里传入的参数是一个Integer, 然后返回类型是一个Category;

调用的时候, 我们可以这样来查询:

        Category c= session.selectOne("getCategory",3);
        System.out.println(c.getName());

然后增:

	Category c = new Category();
        c.setName("新增加的Category");
        session.insert("addCategory",c);

删除:

        Category c = new Category();
        c.setId(6);
        session.delete("deleteCategory",c);

更新:

        Category c= session.selectOne("getCategory",3);
        c.setName("修改了的Category名稱");
        session.update("updateCategory",c);

这里注意的一点是, 这里的parameterType的类型可以是很多, 可以使int, string这些, 但是当要传的是多个参数的时候, 可以使用Map, 像我上面实现了一个getCategoryByIdAndName的功能

    <select id="getCategoryByIdAndName" parameterType="Map" resultType="Category">
        select * from category_ where id>=#{id} and name like concat('%',#{name}, '%')
    select>

在测试类中我是这样做的:

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import pojo.Category;

import java.io.InputStream;
import java.util.HashMap;
import java.util.List;
import java.util.Map;


public class Test {

    public static void main(String[] args) throws Exception {
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        SqlSession sqlSession = sqlSessionFactory.openSession();

        Map<String, Object> m = new HashMap<>();
        m.put("id", 3);
        m.put("name", "cat");
        List<Category> clist = sqlSession.selectList("getCategoryByIdAndName", m);
        for (Category category : clist) {
            System.out.println(category.getName());
        }

    }
}

我传入了两个条目到Map中, 一个是id, 另一个是name, 然后可以通过#{}这样的形式来获得参数;

当然, 这里的parameterType也可以是一个java的类, 比如传一个Category进去, 然后直接通过#{name}来获得这个类的属性;

差不多就是这样, 到这一步为止的代码已经打包上传, 有需要的朋友可以自行下载~
地址:Mybatis的Demo文件打包 使用Maven管理