xml用於提高代碼可讀性

>在項目開發的過程當中,項目組開發成員的編程風格差異和數據庫操作
>語句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, ‘’, ‘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=’’ 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。這個類提供的幾個方法爲外部數據操作的主要方法,
發佈了24 篇原創文章 · 獲贊 41 · 訪問量 8萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章