在Java中呼叫儲存過程(詳細)
本文闡述了怎麼使用DBMS儲存過程。我闡述了使用儲存過程的基本的和高階特性,比如返回ResultSet。本文假設你對DBMS和JDBC已經非常熟悉,也假設你能夠毫無障礙地閱讀其它語言寫成的程式碼(即不是Java的語言),但是,並不要求你有任何儲存過程的程式設計經歷。
儲存過程是指儲存在資料庫並在資料庫端執行的程式。你可以使用特殊的語法在Java類中呼叫儲存過程。在呼叫時,儲存過程的名稱及指定的引數通過JDBC連線傳送給DBMS,執行儲存過程並通過連線(如果有)返回結果。
使用儲存過程擁有和使用基於EJB或CORBA這樣的應用伺服器一樣的好處。區別是儲存過程可以從很多流行的DBMS中免費使用,而應用伺服器大都非常昂貴。這並不只是許可證費用的問題。使用應用伺服器所需要花費的管理、編寫程式碼的費用,以及客戶程式所增加的複雜性,都可以通過DBMS中的儲存過程所整個地替代。
你可以使用Java,
因為儲存過程執行在DBMS自身,這可以幫助減少應用程式中的等待時間。不是在Java程式碼中執行4個或5個SQL語句,而只需要在伺服器端執行1個儲存過程。網路上的資料往返次數的減少可以戲劇性地優化效能。
使用儲存過程
簡單的老的JDBC通過CallableStatement類支援儲存過程的呼叫。該類實際上是PreparedStatement的一個子類。假設我們有一個poets資料庫。資料庫中有一個設定詩人逝世年齡的儲存過程。下面是對老酒鬼Dylan Thomas(old soak Dylan Thomas,不指定是否有關典故、文化,請批評指正。譯註)進行呼叫的詳細程式碼:
try{
int age = 39;
String poetName = "dylan thomas";
CallableStatement proc = connection.prepareCall("{ call set_death_age(?, ?) }");
proc.setString(1, poetName);
proc.setInt(2, age);
cs.execute();
}catch (SQLException e){ // ....}
傳給prepareCall方法的字串是儲存過程呼叫的書寫規範。它指定了儲存過程的名稱,?代表了你需要指定的引數。
和JDBC整合是儲存過程的一個很大的便利:為了從應用中呼叫儲存過程,不需要存根(stub)類或者配置檔案,除了你的DBMS的JDBC驅動程式外什麼也不需要。
當這段程式碼執行時,資料庫的儲存過程就被呼叫。我們沒有去獲取結果,因為該儲存過程並不返回結果。執行成功或失敗將通過例外得知。失敗可能意味著呼叫儲存過程時的失敗(比如提供的一個引數的型別不正確),或者一個應用程式的失敗(比如丟擲一個例外指示在poets資料庫中並不存在“Dylan Thomas”)
結合SQL操作與儲存過程
對映Java物件到SQL表中的行相當簡單,但是通常需要執行幾個SQL語句;可能是一個SELECT查詢ID,然後一個INSERT插入指定ID的資料。在高度規格化(符合更高的正規化,譯註)的資料庫模式中,可能需要多個表的更新,因此需要更多的語句。Java程式碼會很快地膨脹,每一個語句的網路開銷也迅速增加。
將這些SQL語句轉移到一個儲存過程中將大大簡化程式碼,僅涉及一次網路呼叫。所有關聯的SQL操作都可以在資料庫內部發生。並且,儲存過程語言,例如PL/SQL,允許使用SQL語法,這比Java程式碼更加自然。下面是我們早期的儲存過程,使用Oracle的PL/SQL語言編寫:
create procedure set_death_age(poet VARCHAR2, poet_age NUMBER)
poet_id NUMBER;
begin SELECT id INTO poet_id FROM poets WHERE name = poet;
INSERT INTO deaths (mort_id, age) VALUES (poet_id, poet_age);
end set_death_age;
很獨特?不。我打賭你一定期待看到一個poets表上的UPDATE。這也暗示了使用儲存過程實現是多麼容易的一件事情。set_death_age幾乎可以肯定是一個很爛的實現。我們應該在poets表中新增一列來儲存逝世年齡。Java程式碼中並不關心資料庫模式是怎麼實現的,因為它僅呼叫儲存過程。我們以後可以改變資料庫模式以提高效能,但是我們不必修改我們程式碼。
下面是呼叫上面儲存過程的Java程式碼:
public static void setDeathAge(Poet dyingBard, int age) throws SQLException{
Connection con = null;
CallableStatement proc = null;
try {
con = connectionPool.getConnection();
proc = con.prepareCall("{ call set_death_age(?, ?) }");
proc.setString(1, dyingBard.getName());
proc.setInt(2, age);
proc.execute();
}
finally {
try { proc.close(); }
catch (SQLException e) {}
con.close();
}
}
為了確保可維護性,建議使用像這兒這樣的static方法。這也使得呼叫儲存過程的程式碼集中在一個簡單的模版程式碼中。如果你用到許多儲存過程,就會發現僅需要拷貝、貼上就可以建立新的方法。因為程式碼的模版化,甚至也可以通過指令碼自動生產呼叫儲存過程的程式碼。
Functions
儲存過程可以有返回值,所以CallableStatement類有類似getResultSet這樣的方法來獲取返回值。當儲存過程返回一個值時,你必須使用registerOutParameter方法告訴JDBC驅動器該值的SQL型別是什麼。你也必須調整儲存過程呼叫來指示該過程返回一個值。
下面接著上面的例子。這次我們查詢Dylan Thomas逝世時的年齡。這次的儲存過程使用PostgreSQL的pl/pgsql:
create function snuffed_it_when (VARCHAR) returns integer 'declare
poet_id NUMBER;
poet_age NUMBER;
begin
--first get the id associated with the poet.
SELECT id INTO poet_id FROM poets WHERE name = $1;
--get and return the age.
SELECT age INTO poet_age FROM deaths WHERE mort_id = poet_id;
return age;
end;' language 'pl/pgsql';
另外,注意pl/pgsql引數名通過Unix和DOS指令碼的$n語法引用。同時,也注意嵌入的註釋,這是和Java程式碼相比的另一個優越性。在Java中寫這樣的註釋當然是可以的,但是看起來很凌亂,並且和SQL語句脫節,必須嵌入到Java String中。
下面是呼叫這個儲存過程的Java程式碼:
connection.setAutoCommit(false);
CallableStatement proc = connection.prepareCall("{ ? = call snuffed_it_when(?) }");
proc.registerOutParameter(1, Types.INTEGER);
proc.setString(2, poetName);
cs.execute();
int age = proc.getInt(2);
如果指定了錯誤的返回值型別會怎樣?那麼,當呼叫儲存過程時將丟擲一個RuntimeException,正如你在ResultSet操作中使用了一個錯誤的型別所碰到的一樣。
複雜的返回值
關於儲存過程的知識,很多人好像就熟悉我們所討論的這些。如果這是儲存過程的全部功能,那麼儲存過程就不是其它遠端執行機制的替換方案了。儲存過程的功能比這強大得多。
當你執行一個SQL查詢時,DBMS建立一個叫做cursor(遊標)的資料庫物件,用於在返回結果中迭代每一行。ResultSet是當前時間點的遊標的一個表示。這就是為什麼沒有快取或者特定資料庫的支援,你只能在ResultSet中向前移動。
某些DBMS允許從儲存過程中返回遊標的一個引用。JDBC並不支援這個功能,但是Oracle、PostgreSQL和DB2的JDBC驅動器都支援在ResultSet上開啟到遊標的指標(pointer)。
設想列出所有沒有活到退休年齡的詩人,下面是完成這個功能的儲存過程,返回一個開啟的遊標,同樣也使用PostgreSQL的pl/pgsql語言:
create procedure list_early_deaths () return refcursor as 'declare
toesup refcursor;
begin
open toesup for SELECT poets.name, deaths.age FROM poets, deaths -- all entries in deaths are for poets. -- but the table might become generic.
WHERE poets.id = deaths.mort_id AND deaths.age < 60;
return toesup;
end;' language 'plpgsql';
下面是呼叫該儲存過程的Java方法,將結果輸出到PrintWriter:
PrintWriter:
static void sendEarlyDeaths(PrintWriter out){
Connection con = null;
CallableStatement toesUp = null;
try {
con = ConnectionPool.getConnection();
// PostgreSQL needs a transaction to do this... con.
setAutoCommit(false); // Setup the call.
CallableStatement toesUp = connection.prepareCall("{ ? = call list_early_deaths () }");
toesUp.registerOutParameter(1, Types.OTHER);
toesUp.execute();
ResultSet rs = (ResultSet) toesUp.getObject(1);
while (rs.next()) {
String name = rs.getString(1);
int age = rs.getInt(2);
out.println(name + " was " + age + " years old.");
}
rs.close();
}
catch (SQLException e) { // We should protect these calls. toesUp.close(); con.close();
}
}
因為JDBC並不直接支援從儲存過程中返回遊標,我們使用Types.OTHER來指示儲存過程的返回型別,然後呼叫getObject()方法並對返回值進行強制型別轉換。
這個呼叫儲存過程的Java方法是mapping的一個好例子。Mapping是對一個集上的操作進行抽象的方法。不是在這個過程上返回一個集,我們可以把操作傳送進去執行。本例中,操作就是把ResultSet列印到一個輸出流。這是一個值得舉例的很常用的例子,下面是呼叫同一個儲存過程的另外一個方法實現:
public class ProcessPoetDeaths{
public abstract void sendDeath(String name, int age);
}
static void mapEarlyDeaths(ProcessPoetDeaths mapper){
Connection con = null;
CallableStatement toesUp = null;
try {
con = ConnectionPool.getConnection();
con.setAutoCommit(false);
CallableStatement toesUp = connection.prepareCall("{ ? = call list_early_deaths () }");
toesUp.registerOutParameter(1, Types.OTHER);
toesUp.execute();
ResultSet rs = (ResultSet) toesUp.getObject(1);
while (rs.next()) {
String name = rs.getString(1);
int age = rs.getInt(2);
mapper.sendDeath(name, age);
}
rs.close();
} catch (SQLException e) { // We should protect these calls. toesUp.close();
con.close();
}
}
這允許在ResultSet資料上執行任意的處理,而不需要改變或者複製獲取ResultSet的方法:
static void sendEarlyDeaths(final PrintWriter out){
ProcessPoetDeaths myMapper = new ProcessPoetDeaths() {
public void sendDeath(String name, int age) {
out.println(name + " was " + age + " years old.");
}
};
mapEarlyDeaths(myMapper);
}
這個方法使用ProcessPoetDeaths的一個匿名例項呼叫mapEarlyDeaths。該例項擁有sendDeath方法的一個實現,和我們上面的例子一樣的方式把結果寫入到輸出流。當然,這個技巧並不是儲存過程特有的,但是和儲存過程中返回的ResultSet結合使用,是一個非常強大的工具。
結論
儲存過程可以幫助你在程式碼中分離邏輯,這基本上總是有益的。這個分離的好處有:
• 快速建立應用,使用和應用一起改變和改善的資料庫模式。
• 資料庫模式可以在以後改變而不影響Java物件,當我們完成應用後,可以重新設計更好的模式。
• 儲存過程通過更好的SQL嵌入使得複雜的SQL更容易理解。
• 編寫儲存過程比在Java中編寫嵌入的SQL擁有更好的工具--大部分編輯器都提供語法高亮!
• 儲存過程可以在任何SQL命令列中測試,這使得除錯更加容易。
並不是所有的資料庫都支援儲存過程,但是存在許多很棒的實現,包括免費/開源的和非免費的,所以移植並不是一個問題。Oracle、PostgreSQL和DB2都有類似的儲存過程語言,並且有線上的社群很好地支援。
儲存過程工具很多,有像TOAD或TORA這樣的編輯器、偵錯程式和IDE,提供了編寫、維護PL/SQL或pl/pgsql的強大的環境。
儲存過程確實增加了你的程式碼的開銷,但是它們和大多數的應用伺服器相比,開銷小得多。如果你的程式碼複雜到需要使用DBMS,我建議整個採用儲存過程的方式。