iBATIS動態SQL


使用動態查詢是iBatis一個非常強大的功能。有時你已經改變WHERE子句條件的基礎上你的引數物件的狀態。在這種情況下的iBATIS提供了一組可以對映語句中使用,以提高SQL語句的重用性和靈活性的動態SQL標籤。

所有的邏輯是使用一些額外的標籤放在:XML檔案。下面是一個例子,其中的SELECT語句將努力在兩個方面:

  • 如果想傳遞一個ID,然後它會返回所有與該ID的記錄,

  • 否則,將返回所有雇員ID為NULL的記錄。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sqlMap 
PUBLIC "-//ibatis.apache.org//DTD SQL Map 2.0//EN"
"http://ibatis.apache.org/dtd/sql-map-2.dtd">

<sqlMap namespace="Employee">
<select id="findByID" resultClass="Employee">
   SELECT * FROM EMPLOYEE
   <dynamic prepend="WHERE ">
      <isNull property="id">
         id IS NULL
      </isNull>
      <isNotNull property="id">
         id = #id#
      </isNotNull>
   </dynamic>
</select>
</sqlMap>

可以使用<isNotEmpty>標籤如下檢查條件。在此條件下將增加,只有當通過屬性不為空。

..................
<select id="findByID" resultClass="Employee">
   SELECT * FROM EMPLOYEE
   <dynamic prepend="WHERE ">
      <isNotEmpty property="id">
           id = #id#
      </isNotEmpty>
   </dynamic>
</select>
..................

如果想查詢對id和/或雇員的名字選取。SELECT語句如下:

..................
<select id="findByID" resultClass="Employee">
   SELECT * FROM EMPLOYEE
   <dynamic prepend="WHERE ">
      <isNotEmpty prepend="AND" property="id">
           id = #id#
      </isNotEmpty>
      <isNotEmpty prepend="OR" property="first_name">
           first_name = #first_name#
      </isNotEmpty>
   </dynamic>
</select>
..................

例如:動態SQL

下面的例子將展示如何編寫SELECT語句中使用動態SQL。考慮,我們已經在MySQL下有EMPLOYEE表:

CREATE TABLE EMPLOYEE (
   id INT NOT NULL auto_increment,
   first_name VARCHAR(20) default NULL,
   last_name  VARCHAR(20) default NULL,
   salary     INT  default NULL,
   PRIMARY KEY (id)
);

此表有如下只有一條記錄:

mysql> select * from EMPLOYEE;
+----+------------+-----------+--------+
| id | first_name | last_name | salary |
+----+------------+-----------+--------+
|  1 | Zara       | Ali       |   5000 |
|  2 | Roma       | Ali       |   3000 |
|  3 | Noha       | Ali       |   7000 |
+----+------------+-----------+--------+
3 row in set (0.00 sec)

Employee POJO 類:

要執行讀取操作,讓我們在Employee.java檔案Employee類,如下所示:

public class Employee {
  private int id;
  private String first_name; 
  private String last_name;   
  private int salary;  

  /* Define constructors for the Employee class. */
  public Employee() {}
  
  public Employee(String fname, String lname, int salary) {
    this.first_name = fname;
    this.last_name = lname;
    this.salary = salary;
  }

  /* Here are the method definitions */
  public int getId() {
    return id;
  }
  public String getFirstName() {
    return first_name;
  }
  public String getLastName() {
    return last_name;
  }
  public int getSalary() {
    return salary;
  }
} /* End of Employee */

Employee.xml 檔案:

要定義使用iBATIS SQL對映語句,我們將增加在以下檔案Employee.xml修改<select>標記和這個標籤定義,我們將定義一個“id”,這將被用於IbatisReadDy.java檔案上執行動態SQL的SELECT查詢資料庫。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sqlMap 
PUBLIC "-//ibatis.apache.org//DTD SQL Map 2.0//EN"
"http://ibatis.apache.org/dtd/sql-map-2.dtd">

<sqlMap namespace="Employee">
<select id="findByID" resultClass="Employee">
   SELECT * FROM EMPLOYEE
   <dynamic prepend="WHERE ">
      <isNotNull property="id">
         id = #id#
      </isNotNull>
   </dynamic>
</select>
</sqlMap>

上面的SELECT語句將努力在兩個方面(一)如果想傳遞一個ID,然後將相應的編號(二)返回的記錄,否則將返回所有記錄。

IbatisReadDy.java 檔案:

檔案將應用程式級別的邏輯從Employee表讀出的條件記錄:

import com.ibatis.common.resources.Resources;
import com.ibatis.sqlmap.client.SqlMapClient;
import com.ibatis.sqlmap.client.SqlMapClientBuilder;
import java.io.*;
import java.sql.SQLException;
import java.util.*;

public class IbatisReadDy{
  public static void main(String[] args)
   throws IOException,SQLException{
   Reader rd=Resources.getResourceAsReader("SqlMapConfig.xml");
   SqlMapClient smc=SqlMapClientBuilder.buildSqlMapClient(rd);

   /* This would read all records from the Employee table.*/
   System.out.println("Going to read records.....");
   Employee rec = new Employee();
   rec.setId(1);

   List <Employee> ems = (List<Employee>)
                   smc.queryForList("Employee.findByID", rec);
   Employee em = null;
   for (Employee e : ems) {
      System.out.print("  " + e.getId());
      System.out.print("  " + e.getFirstName());
      System.out.print("  " + e.getLastName());
      System.out.print("  " + e.getSalary());
      em = e; 
      System.out.println("");
   }    

   System.out.println("Records Read Successfully ");

  }
} 

編譯和執行:

下面是步驟來編譯並執行上述應用。請確保已在進行的編譯和執行之前,適當地設定PATH和CLASSPATH。

  • 建立Employee.xml如上所示。

  • 建立Employee.java如上圖所示,並編譯它。

  • 建立IbatisReadDy.java如上圖所示,並編譯它。

  • 執行IbatisReadDy二進位制檔案來執行程式。

會得到下面的結果,並且將記錄從EMPLOYEE表中讀取。

Going to read records.....
  1  Zara  Ali  5000
Record Reads Successfully

試試上面的例子中通過傳遞空值作為smc.queryForList(“Employee.findByID”,NULL)。

iBATIS OGNL 表示式

iBATIS的提供了強大的基於OGNL的表示式來消除其他元素。

  • if 語句

  • choose, when, otherwise 語句

  • where 語句

  • foreach 語句

if語句:

最常見的事情在動態SQL是有條件地包括一個where子句的一部分。例如:

<select id="findActiveBlogWithTitleLike"
           parameterType="Blog" resultType="Blog">
   SELECT * FROM BLOG
   WHERE state = 'ACTIVE.
   <if test="title != null">
      AND title like #{title}
   </if>
</select>

這條語句會提供功能的可選的文字搜尋型別。如果沒有傳遞title,那麼所有啟用的部落格將被退回。但是,如果傳遞一個標題,它會尋找標題以like 給定的條件。 

可以包括多個if條件如下:

最常見的事情在動態SQL是有條件地包括一個where子句的一部分。例如:

<select id="findActiveBlogWithTitleLike"
           parameterType="Blog" resultType="Blog">
   SELECT * FROM BLOG
   WHERE state = 'ACTIVE.
   <if test="title != null">
      AND title like #{title}
   </if>
   <if test="author != null">
      AND author like #{author}
   </if>
</select>

choose, when, otherwise 語句:

iBATIS提供了一個選擇的元素,它類似於Java的switch語句。這有助於選擇很多種情況。

下面的例子將只搜尋標題上如果提供,那麼只有由作者如果已提供。如果沒有提供,讓我們只返回精選的部落格:

<select id="findActiveBlogWithTitleLike"
           parameterType="Blog" resultType="Blog">
   SELECT * FROM BLOG
   WHERE state = 'ACTIVE.
   <choose>
      <when test="title != null">
         AND title like #{title}
      </when>
      <when test="author != null and author.name != null">
         AND author like #{author}
      </when>
      <otherwise>
         AND featured = 1
      </otherwise>
   </choose>
</select>

where 語句:

如果我們看一下前面的例子中,如果沒有一個條件滿足會發生什麼事?最終SQL看起來像這樣:

SELECT * FROM BLOG
WHERE

這會失敗,但iBATIS有一個簡單的改變一個簡單的解決方案,讓一切工作正常:

<select id="findActiveBlogLike"
           parameterType="Blog" resultType="Blog">
   SELECT * FROM BLOG
   <where>
      <if test="state != null">
         state = #{state}
      </if>
      <if test="title != null">
         AND title like #{title}
      </if>
      <if test="author != null>
         AND author like #{author}
      </if>
   </where>
</select>

where元素知道只有插入WHERE ,如果有一個由含標籤返回的任何內容。此外,如果該內容開頭AND或OR,它知道剝離其關閉。

foreach語句:

foreach元素是非常強大的,並允許你指定一個集合,宣告可以在元素的體內可用於專案和索引變數。

它也允許你指定開啟和關閉的字串,並新增一個分隔符放置在疊代之間。可以建立一個IN條件如下:

<select id="selectPostIn" resultType="domain.blog.Post">
   SELECT *
   FROM POST P
   WHERE ID in
   <foreach item="item" index="index" collection="list"
      open="(" separator="," close=")">
         #{item}
   </foreach>
</select>