ibatis入门教程一

这几天研究ibatis玩，参考一篇贴子进行安装配置：蓝雪森林

选择这个帖子来跟随配置是因为这个帖子看着比较干净，但是我仍旧在配置得过程中出现了好几个问题，所以我决定在这个帖子的基础上将更多细节加上，做一个傻瓜教程。

一、前期准备

虽然ibatis能处理多种数据库，不过初学者还是比较适应mysql，因此我选择mysql作为我的数据载体。另外我准备建的是一个普通的java 工程，并采用maven命令行来建立这个工程。所以在这之前，电脑上需要安装maven和mysql。

二、工程建立

①使用maven建立java工程框架

②编辑pom.xml文件引入ibatis和mysql的依赖包

<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.0</modelVersion>

    <groupId>com.lipan.ibatis</groupId>
    <artifactId>TestIbatis</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>TestIbatis</name>
    <url>http://maven.apache.org</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.apache.ibatis</groupId>
            <artifactId>ibatis-sqlmap</artifactId>
            <version>2.3.4.726</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.0.5</version>
        </dependency>

    </dependencies>
</project>

③下载依赖包并将maven工程转换为eclipse工程

④建立好的工程目录如下：

其中resource是后面新建的。

三、创建数据库表

可以选择命令行创建，也可以选择用可视化工具（比如Navicat Mysql来创建），我选择的是用Navicat来创建，最终创建的表的样子如下图所示。

其中，本地数据库localhost:3036中我建立了一个tbl_student的表，该表的主键是id，且有自增属性

四、填写ibatis配置文件

这里有三个配置文件：

SqlMap.properties 、SqlMapConfig.xml和Student.xml

ibatis要求首先描述数据库连接信息，这个可以在SqlMap.properties文件里面填写，同时SqlMapConfig.xml文件会读取SqlMap.properties中的信息来初始化数据库，针对每个数据库表，可以用一个专门的xml文件来描述具体的查询操作实现，这里我们建立的针对于tbl_student的xml文件称为Student.xml，接下来会给出其内容。为了组织清晰，在src目录下建立resources目录，用来存放这三个配置文件。

五、具体实现文件

这里有三个文件：

Student.java：与数据库实体对应的POJO类

package com.lipan.ibatis;

import java.sql.Date;
/**
 * @author:lipan
 * Email: areslipan@163.com
 *
 */
public class Student {

    private int id;
    private String name;
    private Date birth;
    private float score;
    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;
    }
    public Date getBirth() {
        return birth;
    }
    public void setBirth(Date birth) {
        this.birth = birth;
    }
    public float getScore() {
        return score;
    }
    public void setScore(float score) {
        this.score = score;
    }
    @Override
    public String toString() {
        return "id=" + id + "\tname=" + name + "\tmajor=" + birth + "\tscore="
                + score + "\n";
    }
    }

StudentDao.java：定义访问数据库的接口

package com.lipan.dao;




import java.util.List;
import com.lipan.ibatis.Student;
/**
* @author xudongwang 2011-12-31
*
* Email:xdwangiflytek@gmail.com
*
*/
public interface StudentDao {
    /**
     * 添加学生信息
     *
     * @param student
     *            学生实体
     * @return 返回是否添加成功
     */
    public boolean addStudent(Student student);

    /**
     * 根据学生id删除学生信息
     *
     * @param id
     *            学生id
     * @return 删除是否成功
     */
    public boolean deleteStudentById(int id);

    /**
     * 更新学生信息
     *
     * @param student
     *            学生实体
     * @return 更新是否成功
     */
    public boolean updateStudent(Student student);

    /**
     * 查询全部学生信息
     *
     * @return 返回学生列表
     */
    public List<Student> selectAllStudent();

    /**
     * 根据学生姓名模糊查询学生信息
     *
     * @param name
     *            学生姓名
     * @return 学生信息列表
     */
    public List<Student> selectStudentByName(String name);

    /**
     * 根据学生id查询学生信息
     *
     * @param id
     *            学生id
     * @return 学生对象
     */
    public Student selectStudentById(int id);
}

StudentDaoImpl.java：访问数据库的具体实现，需要读取SqlMapConfig.xml的配置文件

package com.lipan.daoImpl;

import java.io.IOException;
import java.io.Reader;
import java.sql.SQLException;
import java.util.List;
import com.ibatis.common.resources.Resources;
import com.ibatis.sqlmap.client.SqlMapClient;
import com.ibatis.sqlmap.client.SqlMapClientBuilder;
import com.lipan.dao.StudentDao;
import com.lipan.ibatis.Student;
/**
* @author lipan
*
* Email:areslipan@163.com
*
*/
public class StudentDaoImpl implements StudentDao {
    private static SqlMapClient sqlMapClient = null;
    // 读取配置文件
    static {
        try {
            Reader reader = Resources
                    .getResourceAsReader("SqlMapConfig.xml");

                    //.getResourceAsReader("SqlMapConfig.xml");
            sqlMapClient = SqlMapClientBuilder.buildSqlMapClient(reader);
            reader.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public boolean addStudent(Student student) {
        Object object = null;
        boolean flag = false;
        try {
            object = sqlMapClient.insert("addStudent", student);
            System.out.println("添加学生信息的返回值：" + object);
        } catch (SQLException e) {
            e.printStackTrace();
        }
        if (object != null) {
            flag = true;
        }
        return flag;
    }

    public boolean deleteStudentById(int id) {
        boolean flag = false;
        Object object = null;
        try {
            object = sqlMapClient.delete("deleteStudentById", id);
            System.out.println("删除学生信息的返回值：" + object + "，这里返回的是影响的行数");
        } catch (SQLException e) {
            e.printStackTrace();
        }
        if (object != null) {
            flag = true;
        }
        return flag;
    }

    public boolean updateStudent(Student student) {
        boolean flag = false;
        Object object = false;
        try {
            object = sqlMapClient.update("updateStudent", student);
            System.out.println("更新学生信息的返回值：" + object + "，返回影响的行数");
        } catch (SQLException e) {
            e.printStackTrace();
        }
        if (object != null) {
            flag = true;
        }
        return flag;
    }

    public List<Student> selectAllStudent() {
        List<Student> students = null;
        try {
            students = sqlMapClient.queryForList("selectAllStudent");
        } catch (SQLException e) {
            e.printStackTrace();
        }
        return students;
    }

    public List<Student> selectStudentByName(String name) {
        List<Student> students = null;
        try {
            students = sqlMapClient.queryForList("selectStudentByName", name);
        } catch (SQLException e) {
            e.printStackTrace();
        }
        return students;
    }

    public Student selectStudentById(int id) {
        Student student = null;
        try {
            student = (Student) sqlMapClient.queryForObject(
                    "selectStudentById", id);
        } catch (SQLException e) {
            e.printStackTrace();
        }
        return student;
    }
}

 

六、测试文件

TestIbatis.java

package com.lipan.ibatis;

import java.sql.Date;
import java.util.List;

import com.lipan.daoImpl.StudentDaoImpl;
/**
* @author xudongwang 2011-12-31
*
* Email:xdwangiflytek@gmail.com
*
*/
public class TestIbatis {
public static void main(String[] args) {
        StudentDaoImpl studentDaoImpl = new StudentDaoImpl();
        System.out.println("测试插入");
        Student addStudent = new Student();
        addStudent.setName("李四");
        addStudent.setBirth(Date.valueOf("2011-09-02"));
        addStudent.setScore(88);
        //addStudent.setId(12);
        System.out.println(studentDaoImpl.addStudent(addStudent));
        System.out.println("测试根据id查询");
        System.out.println(studentDaoImpl.selectStudentById(1));
        System.out.println("测试模糊查询");
        List<Student> mohuLists = studentDaoImpl.selectStudentByName("李");
        for (Student student : mohuLists) {
            System.out.println(student);
        }
        System.out.println("测试查询所有");
        List<Student> students = studentDaoImpl.selectAllStudent();
        for (Student student : students) {
            System.out.println(student);
        }
        System.out.println("根据id删除学生信息");
        System.out.println(studentDaoImpl.deleteStudentById(1));
        System.out.println("测试更新学生信息");
        Student updateStudent = new Student();
        updateStudent.setId(1);
        updateStudent.setName("李四1");
        updateStudent.setBirth(Date.valueOf("2011-08-07"));
        updateStudent.setScore(21);
        System.out.println(studentDaoImpl.updateStudent(updateStudent));

}
}

七、项目目录

八、注意

在读取SqlMapConfig.xml的时候，

Reader reader = Resources.getResourceAsReader("SqlMapConfig.xml");会提示 Could not find resource SqlMapConfig.xml，即便将这个路径编程绝对路径也会出错，原因是这个方法最终会调用Classloader.getResource()方法，个函数调用的是相对于classpath的绝对路径，所以load不进去。关于这个问题的详细理解，可以不断在代码中trace，也有个帖子专门讲这个问题。