Như với hầu hết các lựa chọn thay thế khác, việc tạo mã từ WSDL khi sử dụng JAXB 2.x tạo ra cả một tập các lớp liên kết và một tập các lớp mô hình dữ liệu.. Ứng dụng này là một phiên bản
Trang 1Các dịch vụ Web Java: JAXB và JAX-WS trong Axis2
Sử dụng các công nghệ tiêu chuẩn Java JAXB 2.x và JAX-WS 2.x cho các dịch vụ Web Axis2
Dennis Sosnoski, Nhà tư vấn, Sosnoski Software Solutions, Inc
Tóm tắt: Apache Axis2 hỗ trợ một loạt các công nghệ liên kết dữ liệu, bao gồm
tiêu chuẩn Java™ chính thức JAXB 2.x Axis2 cũng hỗ trợ tiêu chuẩn Java cho cấu hình dịch vụ Web, JAX-WS 2.x, như là một sự thay thế cho kỹ thuật cấu hình
tùy chỉnh riêng của nó Dennis Sosnoski tiếp tục loạt bài Các dịch vụ Web Java
của mình bằng cách giải thích bạn có thể sử dụng mỗi tiêu chuẩn Java này với Axis2 như thế nào và thảo luận về một số hạn chế về sự hỗ trợ hiện tại của Axis2 cho chúng
Axis của Apache ban đầu đã dựa vào các tiêu chuẩn Java đầu tiên cho các dịch vụ Web, JAX-RPC Điều này hóa ra không phải là một cách tiếp cận tốt, vì JAX-RPC
đã hạn chế việc thiết kế nội bộ của mã Axis và đã góp phần gây ra cả vấn đề hiệu năng lẫn sự thiếu linh hoạt JAX-RPC cũng đặt một số giả định về hướng phát triển các dịch vụ Web mà sau này hóa ra là sai
Vào lúc mà các nỗ lực phát triển Axis2 đã bắt đầu, một sự thay thế cho JAX-RPC
đã có trong các sản phẩm, vì thế Axis2 đã được thiết kế linh hoạt đủ để thực hiện
sự hỗ trợ cho tiêu chuẩn của các dịch vụ Web thay thế bên trên đỉnh của khung công tác cơ sở Các phiên bản mới đây của Axis2 đã triển khai sự hỗ trợ cho cả tiêu chuẩn liên kết dữ liệu XML Java JAXB 2.x lẫn tiêu chuẩn các dịch vụ Web Java JAX-WS 2.x thay thế cho JAX-RPC Bài viết này cho thấy cách sử dụng JAXB và JAX-WS với Axis2 và nhận biết một số hạn chế về sự hỗ trợ hiện tại của Axis2 cho các tiêu chuẩn này
JAXB trong Axis2
Axis2 thực hiện hỗ trợ cho JAXB 2.x như là một trong những sự lựa chọn liên kết
dữ liệu mà bạn có thể chọn khi sinh mã từ một định nghĩa vụ dịch vụ WSDL (Web Services Description Language –Ngôn ngữ mô tả các dịch vụ Web) bằng công cụ WSDL2Java (Xem "Java Web Services: Axis2 Data Binding" (Các dịch vụ Web: Liên kết dữ liệu Axis2) để đọc về cuộc thảo luận các sự lựa chọn thay thế chủ yếu khác) Như với hầu hết các lựa chọn thay thế khác, việc tạo mã từ WSDL khi sử dụng JAXB 2.x tạo ra cả một tập các lớp liên kết và một tập các lớp mô hình dữ liệu Các lớp liên kết, bao gồm một gốc phía máy khách và một máy thu thông báo phía máy chủ, giao diện giữa mã ứng dụng của bạn và Axis2 Các lớp mô hình dữ liệu biểu diễn dữ liệu thông báo thực tế
Trang 2JAXB 2.x sử dụng các chú thích trong các lớp mô hình dữ liệu để kiểm soát cách biến đổi dữ liệu thành XML và từ XML Cách tiếp cận dùng chú thích cho phép bạn sử dụng các triển khai thực hiện JAXB khác nhau trong thời gian chạy mà không cần phải thay đổi mã nguồn của bạn hoặc biên dịch lại các lớp của bạn Chính việc triển khai thực hiện JAXB có trách nhiệm truy cập thông tin chú thích
từ các lớp mô hình dữ liệu và áp dụng các chú thích này khi biến đổi dữ liệu thành XML và từ XML
Phần tải mã (xem Tải về) cung cấp một ứng dụng ví dụ để giải thích cách sử dụng JAXB trong Axis2, trong thư mục jaxb Ứng dụng này là một phiên bản khác của dịch vụ quản lý thư viện đơn giản đã sử dụng trong các bài viết trước thuộc loạt bài này (bao gồm việc so sánh liên kết dữ liệu trong "Axis2 Data Binding" (Liên kết dữ liệu Axis2) Định nghĩa dịch vụ WSDL xác định bốn hoạt động:
getBook để lấy ra các chi tiết về một cuốn sách cụ thể được xác định theo
Số hiệu sách tiêu chuẩn quốc tế (International Standard Book ISBN)
Number- getBooksByType để lấy ra các chi tiết cho tất cả các cuốn sách của một kiểu cụ thể
getTypes để tìm các kiểu của các cuốn sách có sẵn
addBook để thêm một cuốn sách mới vào thư viện
Liệt kê 1 cho thấy một phiên bản WSDL đã biên tập lại nhiều, chỉ gồm các phần liên quan đến hoạt động getBook:
Liệt kê 1 WSDL của dịch vụ thư viện
Trang 3<wsdl:types>
<schema elementFormDefault="qualified"
targetNamespace="http://ws.sosnoski.com/library/wsdl" xmlns="http://www.w3.org/2001/XMLSchema">
<import namespace="http://ws.sosnoski.com/library/types" schemaLocation="types.xsd"/>
Trang 5<wsdl:output message="wns:getBookResponse" name="getBookResponse"/> </wsdl:operation>
Trang 6về giao diện được bao bọc so với không được bao bọc) Nhưng sự hỗ trợ không được bao bọc sử dụng công cụ WSDL2Java không làm việc với ví dụ này cả trong
mã Axis2 hiện tại lẫn trong một số các bản phát hành gần đây Ít nhất cho đến nay, các phương thức hoạt động có bao bọc là cách duy nhất để sử dụng JAXB với việc tạo mã Axis2 (nhưng hãy xem thảo luận JAX-WS, sắp tới đây, để thấy một cách
Trang 7tiếp cận thay thế) Với giao diện hoạt động có bao bọc, mỗi phương thức dịch vụ cần chỉ một tham số đối tượng khớp với thông báo đầu vào cho hoạt động này và trả về một đối tượng khớp với thông báo đầu ra cho hoạt động này
Các mã đã được cung cấp một sự triển khai thực hiện thực tế của cả dịch vụ lẫn một máy khách thử nghiệm, thiết lập để làm việc với các lớp được tạo ra bằng cách chạy WSDL2Java Như với đoạn mã ví dụ cho các bài viết trước trong loạt bài này, phần tải về bao gồm các tệp build.properties và build.xml được sử dụng
để xây dựng ví dụ này bằng Ant của Apache (trong thư mục jaxb) Trước tiên, bạn cần phải chỉnh sửa tệp build.properties để thiết lập đường dẫn đến bản cài đặt Axis2 của bạn (và thay đổi các giá trị cài đặt khác, nếu cần thiết cho hệ thống của bạn) Sau đó, bạn có thể gõ nhập ant vào một cửa sổ dòng lệnh mở trong thư mục jaxb để chạy WSDL2Java, biên dịch cả mã được cung cấp lẫn mã được tạo ra và xây dựng tệp AAR để triển khai máy chủ Để thử nghiệm nó, đầu tiên triển khai tệp AAR được tạo ra tới bản cài đặt máy chủ Axis2 của bạn và sau đó gõ ant run trên bàn điều khiển
Cách sử dụng JAXB phía máy khách
Máy khách thử nghiệm tạo ra một cá thể của gốc dịch vụ bằng cách sử dụng các tham số điểm đầu cuối dịch vụ được chuyển vào dưới dạng các đối số dòng lệnh
và sau đó thi hành một chuỗi năm cuộc gọi dịch vụ:
1 Lấy thông tin cho một cuốn sách
2 Lấy các kiểu của các cuốn sách trong thư viện
3 Thêm một cuốn sách vào thư viện (sẽ thất bại nếu cuốn sách đã có mặt, như
sẽ xảy ra khi máy khách chạy nhiều hơn một lần mà không khởi động lại máy chủ)
4 Nếu bước cuối cùng đã thành công, cố gắng thêm một cuốn sách khác với cùng một ISBN (phải luôn luôn thất bại)
5 Lấy thông tin về tất cả các cuốn sách của một kiểu cụ thể
Liệt kê 2 cho thấy toàn bộ mã máy khách thử nghiệm Bạn có thể thấy bản chất có bao bọc của giao diện dịch vụ trong các đối tượng của trình bao bọc (wrapper) được sử dụng cho từng hoạt động, ví dụ như là đối tượng GetTypes đã yêu cầu một cuộc gọi đến hoạt động getTypes (mặc dù không có dữ liệu đầu vào nào cho hoạt động này) và đối tượng GetTypesResponse được cuộc gọi này trả về
Trang 8Liệt kê 2 Mã máy khách thử nghiệm JAXB
public class WebServiceClient
// create the client stub
String target = "http://" + args[0] + ":" + args[1] + args[2];
Trang 9
// retrieve the list of types defined
GetTypesResponse gtr = stub.getTypes(new GetTypes());
List<TypeInformation> types = gtr.getGetTypesReturn();
System.out.println("Retrieved " + types.size() + " types:"); for (int i = 0; i < types.size(); i++) {
TypeInformation type = types.get(i);
System.out.println(" '" + type.getName() + "' with " +
type.getCount() + " books");
}
// add a new book
String title = "The Dragon Never Sleeps";
isbn = "0445203498";
try {
Trang 10AddBook ab = new AddBook();
System.out.println("Failed adding '" + title +
"' with ISBN '" + isbn + "' - matches existing title '" +
e.getFaultMessage().getBook().getTitle() + '\'');
}
// get all books of a type
GetBooksByType gbbt = new GetBooksByType();
gbbt.setType("scifi");
GetBooksByTypeResponse gbbtr = stub.getBooksByType(gbbt); List<BookInformation> books = gbbtr.getGetBooksByTypeReturn();
Trang 11System.out.println("Retrieved " + books.size() + " books of type 'scifi':"); for (int i = 0; i < books.size(); i++) {
Cách sử dụng phía máy chủ
Mã phía máy chủ cho dịch vụ thư viện bao gồm hai lớp, một lớp thực hiện việc xử
lý thư viện trên thực tế và lớp kia để tiếp hợp với giao diện dịch vụ mà Axis2 trông đợi Mã thực hiện trên thực tế gần như giống hệt nhau trên các liên kết dữ liệu khác nhau, chỉ có các thay đổi nhỏ cần thiết cho việc biểu diễn mô hình dữ liệu ứng dụng đã tạo ra Liệt kê 3 cho thấy lớp giao diện dịch vụ thú vị hơn Giống như trên máy khách, giao diện được bao bọc yêu cầu mã ứng dụng lấy ra dữ liệu
từ các đối tượng bao bọc (wrapper) đã thu được và xây dựng các đối tượng bao bọc để gửi đi
Liệt kê 3 Mã máy chủ JAXB
public class JaxbLibraryImpl extends JaxbLibrarySkeleton
{
private final BookServer m_server;
Trang 13throw e;
}
}
public GetBookResponse getBook(GetBook req) {
BookInformation book = m_server.getBook(req.getIsbn());
GetBookResponse rsp = new GetBookResponse();
}
public GetTypesResponse getTypes(GetTypes req) {
GetTypesResponse rsp = new GetTypesResponse();
rsp.getGetTypesReturn().addAll(m_server.getTypes());
return rsp;
Trang 14}
}
"Các ứng dụng Web Java: liên kết dữ liệu Axis2" không cho thấy các mã giao diện máy chủ cho các liên kết dữ liệu khác nhau trong bài viết ấy, nhưng nếu bạn so sánh Liệt kê 3 với các phần tải mã thực tế từ bài viết đó, bạn sẽ thấy rằng nó ăn khớp hoàn toàn với các ví dụ về bao bọc ADB và JiBX, một lần nữa sự khác biệt chỉ do việc sử dụng các danh sách định kiểu Java 5 thay cho các mảng
Các lớp mô hình dữ liệu JAXB
Liệt kê 4 cho thấy một số trong các lớp mô hình dữ liệu JAXB được tạo ra bằng cách chạy WSDL2Java (đã xóa hầu hết các lời bình luận tạo ra, ngoại trừ một vài cái để lại như là các ví dụ đại diện) Các lớp mô hình dữ liệu được tạo ra đều giống nhau đối với máy khách và máy chủ, mặc dù chúng được tạo ra riêng rẽ bằng cách xây dựng dự án Các lớp được hiển thị là những lớp được sử dụng cho cuộc gọi getBook trong cả mã máy khách trong Liệt kê 2 và mã máy chủ trong Liệt kê 3 Các chú thích (in đậm) trên mỗi định nghĩa lớp và hầu hết các định nghĩa trường cung cấp thông tin cấu hình mà JAXB sử dụng để kiểm soát việc chuyển đổi các đối tượng thành XML và từ XML
Liệt kê 4 Các lớp mô hình dữ liệu JAXB
Trang 16propOrder = { "author", "title" })
public class BookInformation {
protected List<String> author;
protected String isbn;
public List<String> getAuthor() {
if (author == null) {
author = new ArrayList<String>();
}
return this.author;
Trang 18public void setIsbn(String value) {
public class GetBookResponse {
protected BookInformation getBookReturn;
public BookInformation getGetBookReturn() {
Trang 19Chú thích @XmlAccessorType được sử dụng ở mức gói hoặc mức lớp để kiểm soát các giá trị được truy cập từ lớp đó như thế nào — tất cả các trường, tất cả các thuộc tính với các phương thức truy cập get/set, chỉ các trường và các thuộc tính công cộng (public), hay là chỉ khi được chỉ rõ bởi một chú thích riêng Chú thích
@XmlType được sử dụng trên một định nghĩa lớp hoặc định nghĩa kiểu bảng kê (enum) khớp với một kiểu lược đồ để báo cho JAXB biết tên và vùng tên của kiểu lược đồ (nếu có), thứ tự của các giá trị trong việc biểu diễn kiểu và có thể cả cách
để xây dựng các cá thể của lớp khi sử dụng phương thức nhà máy Chú thích
@XmlRootElement được sử dụng trên một định nghĩa lớp hoặc định nghĩa kiểu bảng kê khớp với một định nghĩa phần tử toàn cục để cung cấp tên và vùng tên của phần tử toàn cục này Các chú thích @XmlElement và @XmlAttribute được sử dụng với các giá trị (như là các trường hay như là các phương thức thuộc tính JavaBean) để cung cấp tên phần tử hoặc thuộc tính và các đặc điểm khác
Tất cả các chú thích được JAXB sử dụng có trong gói javax.xml.bind.annotation, bao gồm các chú thích khác ngoài những chú thích được sử dụng trong mã đã sinh
ra cho ví dụ đơn giản này JAXB hỗ trợ cả việc tạo mã từ các lược đồ, giống như trong trường hợp này lẫn bắt đầu từ mã Một số trong các chú thích và các tùy chọn (ví dụ như những cái làm việc với các nhà máy đối tượng và với các phương thức tuần tự hóa/ không tuần tự hóa (serializer/Deserializer)) chỉ được sử dụng khi bắt đầu từ mã
Các vấn đề JAXB trong Axis2
WSDL2Java gọi trình biên dịch liên kết XJC có chứa trong triển khai thực hiện tham chiếu JAXB để tạo mã mô hình dữ liệu, do đó, trong hầu hết các khía cạnh việc tạo mã mô hình dữ liệu không phụ thuộc vào Axis2 Bạn sẽ tạo ra cùng một
mô hình dữ liệu nếu bạn đã chạy trình biên dịch liên kết JAXB XJC trực tiếp trên các lược đồ được dịch vụ Web sử dụng Thật không may, sự phối hợp nối ghép giữa WSDL2Java và XJC không phải luôn luôn hoàn hảo và dẫn đến một số vấn
đề
Một vấn đề liên quan đến các lược đồ được cấu trúc như thế nào trong các tài liệu WSDL Dạng ban đầu của WSDL cho dịch vụ thư viện đã sử dụng chỉ một tài liệu, tài liệu này kết hợp hai lược đồ riêng rẽ, một cho các phần tử thông báo WSDL và một cho dữ liệu ứng dụng (thông tin về cuốn sách và kiểu) Lược đồ phần tử thông báo đã nhập khẩu lược đồ dữ liệu ứng dụng thông qua tham chiếu vùng tên, như WSDL đã cho phép WSDL này với các lược đồ nhúng trong nó, làm việc tốt với WSDL2Java khi sử dụng liên kết dữ liệu ADB hoặc JiBX, nhưng với JAXB nó gây ra một lỗi ngoại lệ trong lúc xử lý các lược đồ Việc tách ra lược đồ dữ liệu ứng dụng thành một tệp riêng và chỉ rõ tên tệp khi nhập khẩu lược đồ cho phép WSDL2Java xử lý chính xác lược đồ bằng cách sử dụng liên kết JAXB
Trang 20Vấn đề khác là XJC cung cấp một số các tùy chọn tạo mã, cũng như rất nhiều tùy chỉnh để kiểm soát các chi tiết của việc tạo mã cho các thành phần lược đồ cụ thể
— nhưng WSDL2Java không cung cấp bất kỳ cách nào để chuyển các tùy chọn này hoặc các tuỳ chỉnh này cho XJC, vì thế việc tạo mã luôn luôn chạy với các giá trị cài đặt mặc định Nếu bạn cần phải sử dụng bất kỳ các tùy chọn hoặc tuỳ chỉnh tạo mã nào, bạn có thể phải chạy XJC tách riêng với WSDL2Java Thật không may, không có cách nào để sử dụng một mô hình dữ liệu JAXB được tạo ra riêng biệt trong việc tạo mã với WSDL2Java Nếu bạn cần phải sử dụng một mô hình dữ liệu JAXB có tùy chỉnh, thì cách tiếp cận tốt nhất của bạn có thể sẽ là chạy
WSDL2Java để tạo ra mô hình dữ liệu JAXB riêng của nó, sau đó thay thế vào các lớp mô hình dữ liệu được tạo ra riêng rẽ của bạn và viết mã sửa đổi bằng tay nếu cần thiết để nối tạm tất cả mọi thứ cùng nhau Ngoài ra, bạn có thể sử dụng JAX-
WS, như được mô tả trong phần tiếp theo, cho phép bạn bỏ qua hoàn toàn việc sử dụng WSDL2Java, nhưng có một số hạn chế lớn
Sử dụng JAX-WS trong Axis2
Trong khi JAXB có thể được sử dụng như là một kỹ thuật liên kết dữ liệu thay thế khác cho Axis2, thì JAX-WS có những điểm khác biệt sâu sắc hơn nhiều JAX-
WS là một cách tiếp cận khác hoàn toàn để định nghĩa các dịch vụ Web và nó hoàn toàn thay thế cấu hình phía máy chủ và phía máy khách của Axis2 tiêu
chuẩn Bạn tạo mã JAX-WS từ WSDL bằng cách sử dụng một công cụ WsImport,
có chứa trong triển khai thực hiện tham khảo JAX-WS (phải tải xuống tách biệt với Axis2, xem Tài nguyên), chứ không dùng WSDL2Java Ngay cả cơ cấu triển khai cũng khác với cách tiếp cận tệp-AAR thường được sử dụng với Axis2
Phần tải mã cung cấp một phiên bản thứ hai của cùng một ứng dụng ví dụ được sử dụng trước đó, ví dụ này được sửa đổi để giải thích cách sử dụng JAX-WS trong Axis2 Mã của nó nằm trong thư mục jaxws của phần tải về này và nó có WSDL, build.properties và build.xml riêng của mình WSDL cho phiên bản JAX-WS này
về cơ bản giống như phiên bản đã sử dụng cho JAXB, được hiển thị trong Liệt kê
1 Sự khác biệt chính trong WSDL là nó sử dụng một lược đồ nhúng cho dữ liệu ứng dụng, không làm việc được với WSDL2Java khi sử dụng liên kết dữ liệu JAXB
Khi bạn tạo mã từ WSDL bằng cách sử dụng công cụ WsImport của JAX-WS, bạn nhận được một mô hình dữ liệu và các lớp trình bao bọc JAXB giống như khi bạn
sử dụng WSDL2Java cho việc tạo mã JAXB Các sự khác biệt ở trong mã liên kết,
mã này trong trường hợp của JAX-WS bao gồm một giao diện dịch vụ được tạo ra