使用XML封裝數據庫操作語句的實現

2024-07-21 02:31:24

字體：大中小

來源：轉載

供稿：網友

在項目開發的過程當中，項目組開發成員的編程風格差異和數據庫操作語句SQL的靈活性給項目組帶來了越來越多的操作和維護難度。
比如：從user表中取出所有數據，有的人會寫成“select * from user”，有的人會寫成“select all from user”，雖然在操作中不會有任何的錯誤，但在其他人讀程序的過程時就會產生不好的感覺。
如果這種程序差異在項目中的數量級很多，那么在開發的過程當中程序就會出現各種各樣的風格，在維護的過程中就會拼命的撓頭并詛咒那些當初寫程序的人。

為了整篇文章的舉例，現在我們在數據庫中建立如下表
TBL_USER
USERID BIGINT
USERNAME VARCHAR(20)
PASSWord VARCHAR(20)
CREATETIME DATE

TBL_USER_INFO
USERID BIGINT
EMAIL VARCHAR(64)
MOBILE VARCHAR(13)

一、分析

A、分析select語句

于是使用xml來封裝數據庫操作語句成為項目規范化操作的第一步驟。在這個步驟中，我們將舉幾個例子來逐步實現封裝的目的。
比如 “ SELECT USERNAME, PASSWORD FROM TBL_USER ” 這個語句，分析成XML文件時可以有各種各樣的寫法，我們現在使用如下的表達方式：
分析（1）
1 <dbtrans name=“selectUser” table=“TBL_USER” method=“select”>
2 <get>
3 <PRoperty name=“username” type=“string”/>
4 <property name=“password” type=“string”/>
5 </get>
6 </dbtrans>
在第一行的句子中使用 dbtrans 為節點名稱，
屬性name為這個交易的名稱，這里為“selectUser”，
屬性table為索取表的名稱，這里為“TBL_USER”，
屬性method為操作數據庫的方法，這里為“select”，
子節點<get></get>意思為從數據庫讀取數據。
子節點<property />為讀取的數據庫字段，其中：
屬性name為字段的名字，
屬性type 為字段的類型，這里設置類型在后面的程序中可以體現出來。

對于“SELECT USERNAME, PASSWORD FROM TBL_USER WHERE USERID=123”語句，我們根據上述的分析，則可將XML描繪為：
分析（2）
1. <dbtrans name=“selectUserByKey” table=“TBL_USER” method=“select”>
2. <key>
3 <property name=“userid” type=“long”/>
4 </key>
5 <get>
6 <property name=“username” type=“string”/>
7 <property name=“password” type=“string”/>
8 </get>
9 </dbtrans>
如果使用的是like操作，我們可以將第3句描述成為<property name=“username” type=“string” match=“like”/>

對于“SELECT USERNAME, PASSWORD FROM TBL_USER ORDER BY USERNAME DESC”這個語句，XML如下分析：
分析（3）
1. <dbtrans name=”selectUser” table=”TBL_USER” method=”select”>
2 <get>
3 <property name=”username” type=”string”/>
4 <property name=”password” type=”string”/>
5 </get>
6 <order name="respcode" match="desc" />
7 </dbtrans>
這樣的語句分析基本上可以完成了絕大部分的普通數據庫的select語句的操作，但是畢竟還是會有一些我們無法預料的數據庫操作語句會出現，比如
“SELECT USERNAME, PASSWORD FROM TBL_USER WHERE CREATETIME >‘2003-7-16’ AND CREATETIME<‘2003-9-16’”時，同時出現了CREATETIME在 <key>之中，這時我們可以將XML描繪成為：
<key>
<property name=“starttime” column=“createtime” type=“date” match=“>”>
<property name=“endtime” column=“createtime” type=“date” match=“<”>
</key>

但即使使用了以上的變通方法，還是會有很多的特殊語句是無法完成的，比如 “ SELECT COUNT(*) FROM TBL_USER ”，這時的操作會出現使用XML語句無法描繪的時候，這個時候我們就可以引入了special這個屬性，例如：
分析（4）
1 <dbtrans name=”selectUser” table=”TBL_USER” method=”select” special=”select count(*) from tbl_user”>
2 </dbtrans>
這個屬性的意思是將所有的特殊交易都特殊表現出來。

B、分析INSERT語句

INSERT 語句在關系型數據庫中操作可以說是最麻煩的一條語句了，因為如果你需要在TBL_USER和TBL_USER_INFO表中建立一條對應的數據時，你需要知道插入數據庫的主鍵的值，在JDBC3.0中可以使用Statement.RETURN_GENERATED_KEYS來獲取，但是如果為了兼容性考慮，我們在操作過程之中決定采用另一種辦法來實現。
我們在數據庫中建立一個表，名為：TSYS_PRIMARYKEY,其中包括三個字段,如下：
TSYS_PRIMARYKEY
KEYID BIGINT
TABLENAME VARCHAR(64)
PRIMARYKEY VARCHAR(30)
其中TABLENAME保存表名，PRIMARYKEY保存主鍵的名稱，KEYID保存主鍵的值，這樣的做法目的是在insert語句操作前，先取到現在主鍵的值，并將該值加1，成為現有的主鍵，然后進行insert操作，操作完成之后我們還需要update一下TSYS_PRIMARYKEY這個表，確保數據的同步。
現在我們開始分析 INSERT語句了，
INSERT INTO TBL_USER ( USERID, USERNAME, PASSWORD ) VALUES ( 100, ‘test’, ‘test’ )
INSERT INTO TBL_USER_INFO ( USERID, EMAIL, MOBILE ) VALUES ( 100, ‘[email protected]’, ‘1234567890’ )

描繪為XML文件時我們可以描繪如下
分析5）
1. <dbtrans name=“insertUser” table=“TBL_USER” method=“insert”>
2 <primarykey name=“userid” >
3 <set>
4 <property name=“username” type=“string”/>
5 <property name=“password” type=“string”/>
6 </set>
7 </dbtrans>
以及
1 <dbtrans name=“insertUserInfo” table=“TBL_USER_INFO” method=“insert”>
2 <set>
3 <property name=“userid” type=“long”/>
4 <property name=“email” type=“string”/>
5 <property name=“mobile” type=“string”/>
6 </set>
7 </dbtrans>

C、分析DELETE語句

Delete語句最常用的可以分為兩種，一種是按照鍵值刪除，一種是全部刪除，為此我們將此操作劃分為兩種類型，delete和clear
對于delete類型，舉例為：
DELETE FROM TBL_USER_INFO WHERE USERID=123
描述為：
分析（6）
1 <dbtrans name=“deleteUserInfo” table=“TBL_USER_INFO” method=“delete”>
2 <key>
3 <property name=“userid” type=“long” />
4 </key>
5 </dbtrans>

對于clear類型，舉例為：
DELETE FROM TBL_USER_INFO
描述為：
分析（7）
1 <dbtrans name=“clearUserInfo” table=“TBL_USER_INFO” method=“clear”>
2 </dbtrans>

D、分析UPDATE語句

從update通常的操作我們可以知道使用XML描述時將會出現兩種tag，包括<key>和<set>，比如：
UPDATE TBL_USER_INFO SET EMAIL=’[email protected]’ WHERE USERID=123
描述稱XML為：
分析8）
1. <dbtrans name=“updateUserInfo” table=“TBL_USER_INFO” method=“update”>
2 <key>
3 <property name=“userid” type=“long” />
4 </key>
5 <set>
6 <property name=“email” type=“string” />
7 </set>
8 </dbtrans>

二、程序設計

好的，在分析了XML文件之后需要我們進入到程序的設計上來了。從以上實現的分析我們可以清楚的看到要實現以上操作，我們必須要做到以下幾步：
1   讀取XML文件
2   定位相應的交易節點
3   拼SQL 語句
4   數據庫操作
5   取數據
6   返回數據

其中針對第一步的讀取文件，我們可以封裝所有的XML parse語句以及前期的操作封裝進入一個類之中，這里我們命名為 XMLLoadFile。

交易處理的過程包括2，5，6三個步驟，可以封裝成XMLTransaction類中。當然返回數據這個操作可以單獨抽出來作為一個相應的返回類，如果這樣是為了在返回的數據報文做處理，比如可以返回XML，Vector或者Hashtable或Map等。這里暫定返回數據為Vector類型，所以將第6步封裝進來。

拼裝SQL語句，獨立建立一個類（XMLCombine），當然也可以分為多個，比如SelectCombine，insertCombine等，這里我們進行統一封裝。

數據庫操作單獨封裝成一個類，XMLExecuteSQL。

以上所有的類統一了一個出口類，這里為XMLUtils。這個類提供的幾個方法為外部數據操作的主要方法，比如select, insert, delete, update等，還有提供外部程序存取數據的幾個方法，比如：setTransNode(設置交易節點)，setTransValue(設置交易數據值), setTransKeyValue(設置交易鍵值數據值)

三、外部程序調用

對于select語句，分析（1）所需編寫的程序如下
XMLUtils util = new XMLUtils();
util.setTransNode(“selectUser”);
Vector vRtn = util.select( con );

分析（2）為
XMLUtils util = new XMLUtils();
util.setTransNode(“selectUserByKey”);
util.setTransKeyValue(“userid”, 123 );
Vector vRtn = util.select( con );

對于insert語句，分析（5）程序如下
XMLUtils util = new XMLUtils();
util.setTransNode(“insertUser”);
util.setTransValue(“username”, “test” );
util.setTransValue(“password”, “test” );
Vector vRtn = util.insert( con ); //假設操作成功
long userid = ((Long)((Hashtable)vRtn.elementAt(0)).get(“userid”)).longValue();

util.setTransNode(“insertUserInfo”);
util.setTransValue(“userid”, userid );
util.setTransValue(“email”, “[email protected]” );
util.setTransValue(“mobile”, “1234567890” );
Vector vRtn = util.insert( con );

對于 delete語句分析（ 6）程序如下
XMLUtils util = new XMLUtils();
util.setTransNode(“deleteUser”);
util.setTransKeyValue(“userid”, 100);
util.delete( con );

對于update語句,分析（ 8）程序如下
XMLUtils util = new XMLUtils();
util.setTransNode(“updateUserInfo”);
util.setTransKeyValue(“userid”, 123);
util.setTransValue(“email”, “[email protected]”);
util.update( con );

大家在看這些SQL的操作時，是不是覺得很工整，也很舒服呢？這樣做的好處很多，程序員可以不必太多的去拼寫SQL 語句，封裝的操作可以使所有程序員的程序都可以寫的很工整，并有統一的風格。

Keli [email protected]

word文檔放置于此 http://keli.nease.net/XMLDB.doc

最新jar包放置于 http://keli.nease.net/iartbean/iartbean.jar

Sample 放置于 http://keli.nease.net/iartbean/Sample.java
import com.iart.DataBase.XMLControl.*;
import com.microsoft.*;
import java.sql.*;
import java.util.*;
public class Sample{

public static void main( String[] args ){

XMLUtils util = new XMLUtils();
Connection con = null;
try{
   System.out.println("[StartupServlet]begin ==============================================");
   util.StartupServlet();
   System.out.println("[StartupServlet]end ==============================================");
   con = getConnection();
   System.out.println("[GetConnection]"+ con.toString() );
   //
/*   util.setTransNode( "clear" );
   util.clear(con);

   util.setTransNode( "setpassbyname" );
   util.setTransValue( "logonname", "keli2" );
   util.setTransValue( "username", "keli3" );
   util.setTransValue( "password", "hnh3" );
   util.insert(con);
*/

   util.setTransNode("backemail","selectRespCode");
   //util.setTransKeyValue( "starttime","2003-08-22 00:00:00.0" );
   //util.setTransKeyValue( "endtime","2003-08-22 23:59:59.0" );
   //util.setTransKeyValue( "docstatusid","2" );

   //util.setTransValue( "createtime","CURRENT_TIMESTAMP" );



/*   util.setTransNode("insertDocument");
   util.setTransValue( "doctypeid", "2");
   util.setTransValue( "docstatusid", "1" );

   Vector vRtn = util.insert(con);
*/
   Hashtable vRtn = util.select(con, 0, -1 );
   System.out.println(vRtn.toString());
   System.out.println(((Vector)vRtn.get("DATA")).size());

   util.setTransNode("backemail","selectRespCode");
     vRtn = util.select(con, 2, 20 );
   System.out.println(vRtn.toString());
   System.out.println(((Vector)vRtn.get("DATA")).size());

   vRtn = util.select(con,3, 20 );
    System.out.println(vRtn.toString());
    System.out.println(((Vector)vRtn.get("DATA")).size());
/*   util.setTransNode("selectmaxdoc");
   Vector vResult = util.select(con);
   Long docid = (Long)((Hashtable)vResult.elementAt(0)).get("docid");

   util.setTransNode("insertEmail");
   util.setTransValue( "mid", docid.toString());
   util.setTransValue( "subject", "test" );
   util.setTransValue( "targetaddr", "[email protected]" );
   util.setTransValue( "sourceaddr", "[email protected]" );
   util.setTransValue( "content", "[email protected]" );

   util.insert(con);

   util.setTransNode("selectemail");
   Vector vResult1 = util.select(con);

   for( int i=0; i< vResult1.size(); i++ )
   {
    Hashtable vColumn = (Hashtable)vResult1.elementAt(i);
    if( vColumn != null )
      System.out.println("1"+vColumn.toString() );
   }

*/

/*   util.setTransNode( "deletebyname" );
   util.setTransKeyValue("logonname", "keli");
   util.delete(con);

   util.setTransNode("getpassbyname");
   util.setTransKeyValue( "logonname", "%keli%" );
   Vector vResult2 = util.select(con);

   for( int i=0; i< vResult2.size(); i++ )
   {
    Hashtable vColumn = (Hashtable)vResult2.elementAt(i);
    if( vColumn != null )
      System.out.println(vColumn.toString() );
   }
*/
}catch( Exception ex )
{
   ex.printStackTrace();
}finally{
   try{
    con.close();
   }catch(Exception ex1)
   {
    System.out.println(ex1.getMessage());
   }
}

}

public static Connection getConnection() throws Exception{
Class.forName("com.microsoft.jdbc.sqlserver.SQLServerDriver");
String strCon = "jdbc:microsoft:sqlserver://localhost:1433;User=nlc;Password=nlc;DatabaseName=nlc";
       Connection conn = DriverManager.getConnection(strCon);
return conn;
}