Trong bài viết thứ ba của loạt bài Ajax cho các nhà phát triển Java™ này, Philip McCarthy cho bạn thấy cách sử dụng Direct Web Remoting DWR-Truy cập Web trực tiếp từ xa để trực tiếp đặt
Trang 1Ajax cho các nhà phát triển Java: Ajax với Direct Web Remoting
Sự tuần tự hóa dữ liệu không dễ dàng hơn điều này!
Philip McCarthy, Nhà Phát triển, SmartStream Technologies Ltd
Tóm tắt: Thật thú vị như nó có, việc thêm chức năng Ajax cho các ứng dụng của
bạn có thể mang lại nhiều việc khó khăn Trong bài viết thứ ba của loạt bài Ajax cho các nhà phát triển Java™ này, Philip McCarthy cho bạn thấy cách sử dụng
Direct Web Remoting (DWR-Truy cập Web trực tiếp từ xa) để trực tiếp đặt các phương thức JavaBeans vào mã JavaScript của bạn và tự động hóa công việc đòi hỏi sự nỗ lực của Ajax
Hiểu biết những điều căn bản về lập trình Ajax (fundamentals of Ajax
programming) là điều cần thiết, nhưng nếu bạn đang xây dựng các giao diện người dùng (UI) Ajax phức tạp, điều quan trọng là có thể làm việc ở một mức độ trừu
tượng cao hơn Trong bài viết thứ ba của loạt bài Ajax cho các nhà phát triển Java
này, tôi thêm phần giới thiệu của số trước vào các kỹ thuật tuần tự hóa dữ liệu cho Ajax (data serialization techniques for Ajax), giới thiệu một kỹ thuật cho phép bạn tránh những chi tiết thực dụng của việc tuần tự hóa các đối tượng Java
Trong bài trước, tôi đã chỉ cho bạn cách sử dụng JavaScript Object Notation
(JSON- Ký hiệu đối tượng JavaScript) để tuần tự hóa dữ liệu theo một định dạng
dễ dàng được chuyển đổi thành các đối tượng JavaScript trên máy khách Với thiết lập này, bạn có thể gọi các cuộc gọi dịch vụ từ xa khi sử dụng mã JavaScript và nhận các đồ thị đối tượng JavaScript trả lời, không giống như việc thực hiện một cuộc gọi thủ tục từ xa Bây giờ, bạn sẽ tìm hiểu cách tiến thêm một bước nữa, bằng cách sử dụng một khung công tác chính thức hóa khả năng của bạn để thực hiện cuộc gọi thủ tục từ xa trên các đối tượng Java phía máy chủ từ mã máy khách JavaScript
DWR là một giải pháp được cấp phép Apache, mã nguồn mở gồm các thư viện Java phía máy chủ, một servlet DWR và các thư viện JavaScript Trong khi DWR không chỉ là bộ công cụ Ajax-RPC có sẵn cho nền tảng Java, mà nó còn là một trong những giải pháp hoàn thiện nhất và cung cấp rất nhiều chức năng có ích Xem Tài nguyên để tải về DWR trước khi tiếp tục các ví dụ
DWR là gì?
Theo các thuật ngữ đơn giản nhất, DWR là một công cụ đặt các phương thức của các đối tượng Java phía máy chủ theo mã JavaScript Thực tế, với DWR, bạn có thể loại bỏ tất cả máy theo chu trình yêu cầu-trả lời của Ajax ra khỏi mã ứng dụng
Trang 2của bạn Điều này có nghĩa là mã phía máy khách của bạn không bao giờ phải xử
lý trực tiếp một đối tượng XMLHttpRequest hoặc xử lý trả lời của máy chủ Bạn không cần phải viết mã tuần tự hóa đối tượng hoặc sử dụng các công cụ của bên thứ ba để chuyển các đối tượng của bạn sang XML Bạn thậm chí không cần phải viết mã servlet để dàn xếp các yêu cầu Ajax thành các cuộc gọi trên các đối tượng miền Java của bạn
DWR được triển khai như là một servlet trong ứng dụng Web của bạn Được xem như hộp đen, servlet này thực hiện hai vai trò chính: Thứ nhất, với mỗi lớp được trưng ra, DWR tự động tạo Javascript để có trong trang Web của bạn JavaScript được tạo có chức năng stub để thể hiện các phương thức tương ứng trên lớp Java
và cũng thực hiện các XMLHttpRequest ở hậu trường Các yêu cầu này được gửi tới servlet DWR, mà servlet DWR, trong vai trò thứ hai của mình, dịch chuyển yêu cầu đó thành một cuộc gọi phương thức trên một đối tượng Java phía máy chủ
và gửi các giá trị trả về tới phía máy khách theo dạng trả lời servlet của nó, được
mã hóa thành JavaScript DWR cũng cung cấp các hàm tiện ích JavaScript giúp thực hiện các nhiệm vụ UI chung
Về ví dụ này
Trước khi giải thích DWR chi tiết hơn, tôi sẽ giới thiệu một kịch bản ví dụ đơn giản Như trong các bài viết trước đây, tôi sẽ sử dụng một mô hình tối thiểu dựa trên một cửa hàng trực tuyến, lúc này có một thể hiện sản phẩm cơ bản, một giỏ mua hàng của người dùng có thể chứa các mục và một đối tượng truy cập dữ liệu (DAO) để tìm kiếm các chi tiết sản phẩm từ một kho dữ liệu Lớp Item là một lớp giống như được sử dụng trong bài viết trước, nhưng nó không còn thực hiện bất kỳ các phương thức tuần tự hóa nào bằng thủ công Hình 1 mô tả thiết lập đơn giản này:
Trang 3Hình 1 Biểu đồ lớp mô tả các giỏ hàng, CatalogDAO và các lớp Item
Tôi sẽ trình diễn hai trường hợp sử dụng rất đơn giản trong kịch bản này Trước tiên, người dùng có thể thực hiện tìm kiếm văn bản trên danh mục và xem các mục phù hợp Thứ hai, người sử dụng có thể thêm các mục vào giỏ mua hàng và xem tổng chi phí của các mục trong giỏ hàng
Thực hiện danh mục
Điểm khởi đầu của một ứng dụng DWR là viết mô hình đối tượng phía máy chủ của bạn Trong trường hợp này, tôi bắt đầu bằng cách viết một DAO để cung cấp các khả năng tìm kiếm trên kho dữ liệu (datastore) danh mục sản phẩm
CatalogDAO.java là một lớp không trạng thái, đơn giản với một số hàm tạo
không-đối số Liệt kê 1 cho thấy các điểm đặc trưng của các phương thức Java mà tôi muốn để trưng ra cho các máy khách Ajax:
Liệt kê 1 Các phương thức CatalogDAO để trưng ra qua DWR
/**
Trang 4* Returns a list of items in the catalog that have
* names or descriptions matching the search expression
* @param expression Text to search for in item names
* Returns the Item corresponding to a given Item ID
* @param id The ID code of the item
* @return the matching Item
*/
public Item getItem(String id);
Tiếp theo, tôi cần cấu hình DWR, cho nó biết các máy khách Ajax nên có khả năng xây dựng một CatalogDAO và gọi các phương thức này Tôi thực hiện việc này với tệp cấu hình dwr.xml được hiển thị trong Liệt kê 2:
Liệt kê 2 Cấu hình để trưng ra các phương thức CatalogDAO
<!DOCTYPE dwr PUBLIC
Trang 5"-//GetAhead Limited//DTD Direct Web Remoting 1.0//EN"
Trang 6Phần tử create báo cho DWR biết một lớp phía máy chủ nên được trưng ra cho các yêu cầu Ajax và định nghĩa cách DWR nhận được một cá thể của lớp đó từ xa Thuộc tính creator ở đây được đặt tới giá trị new, có nghĩa là DWR sẽ gọi hàm tạo mặc định của lớp để nhận được một cá thể Các khả năng khác là tạo một cá thể thông qua một đoạn kịch bản lệnh bằng cách sử dụng Bean Scripting Framework (BSF-Khung công tác tạo kịch bản lệnh Bean) hoặc để nhận được một cá thể thông qua việc tích hợp với thùng chứa IOC, Spring Theo mặc định, khi yêu cầu Ajax với DWR gọi creator, đối tượng cụ thể được đặt trong phạm vi trang và do
đó không còn tồn tại sau khi yêu cầu hoàn tất Trong trường hợp của CatalogDAO không trạng thái, điều này là tốt
Thuộc tính javascript của phần tử create xác định tên mà đối tượng sẽ có thể truy cập từ mã JavaScript Được lồng bên trong phần tử create , phần tử param xác định lớp Java mà phần tử creator sẽ tạo ra Cuối cùng, các phần tử, include xác định các tên của các phương thức sẽ được trưng ra Việc bắt đầu các phương thức
để trưng ra là thực tế tốt để tránh vô tình cho phép truy cập chức năng có thể gây hại nếu phần tử này được bỏ qua, tất cả các phương thức của lớp sẽ được trưng
ra các cuộc gọi từ xa Lần lượt, bạn có thể sử dụng các phần tử exclude (loại trừ)
để xác định chỉ những phương thức nào bạn muốn ngăn chặn truy cập vào
Phần tử convert
Trong khi các creator có liên quan tới việc trưng ra các lớp và các phương thức của chúng cho việc truy cập Web từ xa, các convertor (trình chuyển đổi) có liên quan đến các kiểu tham số và kiểu trả về của các phương thức đó Vai trò của phần
tử convert là để nói cho DWR biết cách chuyển đổi các kiểu dữ liệu giữa việc thể hiện đối tượng Java phía máy chủ của chúng và việc thể hiện JavaScript được tuần
tự hóa và ngược lại
DWR tự động dàn xếp các kiểu dữ liệu đơn giản giữa các thể hiện Java và
JavaScript Các kiểu này gồm các gốc Java, cùng với các thể hiện lớp tương ứng của chúng, cũng như các kiểu Strings và Dates, Mảng và các kiểu bộ sưu tập DWR cũng có thể chuyển đổi JavaBeans thành các thể hiện JavaScript, nhưng vì
lý do bảo mật, việc thực hiện như vậy cần cấu hình rõ ràng
Phần tử convert trong Liệt kê 2 báo cho DWR sử dụng trình chuyển đổi bean dựa trên phản chiếu của nó cho các Item được trả về bằng các phương thức đã cho biết của CatalogDAO và chỉ định các bộ phận của Item nào cần có trong tuần tự hóa Các bộ phận được xác định bằng cách sử dụng quy ước đặt tên JavaBean, vì thế DWR sẽ gọi các phương thức get tương ứng Trong trường hợp này, tôi đang bỏ qua trường price (giá cả) bằng số và thay vào đó có trường formattedPrice, có sẵn định dạng tiền tệ để hiển thị
Trang 7Lúc này tôi đã sẵn sàng triển khai dwr.xml của tôi sang thư mục WEB-INF của ứng dụng Web của mình, ở đó DWR servlet sẽ chọn nó Tuy nhiên, trước khi tiếp tục, để đảm bảo rằng tất cả mọi thứ đang làm việc như mong đợi là một ý tưởng tốt
Thử nghiệm triển khai
Nếu định nghĩa web.xml của DWRServlet đặt init-param debug là true (đúng), thì sau đó chế độ thử nghiệm vô cùng có ích của DWR được kích hoạt Việc chuyển hướng tới /{your-web-app}/dwr/ sẽ đưa ra một danh sách các lớp của bạn đã được DWR đặt cấu hình truy cập từ xa Việc nhấn chuột sẽ đưa bạn tới màn hình trạng thái cho một lớp cụ thể Trang thử nghiệm DWR cho CatalogDAO được hiển thị trong Hình 2 Cũng như việc cung cấp một thẻ script để dán vào các trang Web của bạn, việc trỏ tới JavaScript được tạo của DWR cho lớp đó, màn hình này cũng cung cấp một danh sách các phương thức của lớp Danh sách này gồm các phương thức được thừa kế từ các siêu kiểu của lớp, nhưng chỉ những có các phương thức nào mà tôi xác định rõ ràng để truy cập từ xa trong dwr.xml được đánh dấu là có thể truy cập được
Trang 8Hình 2 Trang thử nghiệm DWR cho CatalogDAO
Có thể nhập các giá trị tham số vào các hộp văn bản bên cạnh các phương thức
được phép truy cập và nhấn nút Execute (Thực hiện) để gọi chúng Trả lời của
máy chủ sẽ được hiển thị bằng cách sử dụng ký hiệu của JSON trong một hộp cảnh báo, trừ khi nó là một giá trị đơn giản; trong trường hợp này nó được hiển thị nội tuyến dọc theo các phương thức Các trang thử nghiệm này rất có ích Không chỉ chúng cho phép bạn dễ dàng kiểm các lớp và phương thức nào được trưng ra
để truy cập từ xa, mà bạn cũng có thể thử nghiệm xem mỗi phương thức có đang hoạt động như mong đợi không
Một khi bạn đã hài lòng rằng các phương thức được truy cập từ xa của bạn đang hoạt động đúng, bạn có thể sử dụng các stub (nhánh rẽ) JavaScript được tạo của DWR để gọi các đối tượng phía máy chủ của bạn từ mã phía máy khách
Gọi một đối tượng được truy cập từ xa
Trang 9Việc ánh xạ giữa các phương thức đối tượng Java được truy cập từ xa và các hàm stub JavaScript tương ứng của chúng là đơn giản Dạng chung là
JavaScriptName.methodName(methodParams , callBack), ở đây
JavaScriptName là bất kỳ tên đã được xác định như là thuộc tính javascript của
creator, methodParams thể hiện các tham số n của phương thức Java và callback
(gọi lại) là một hàm JavaScript, nó sẽ được gọi với giá trị trả về của phương thức Java Nếu bạn quen với Ajax, bạn sẽ nhận ra cơ chế gọi lại như là cách tiếp cận thông thường cho sự không đồng bộ của XMLHttpRequest
Trong kịch bản ví dụ này, tôi sử dụng các hàm JavaScript trong Liệt kê 3 để thực hiện tìm kiếm và cập nhật giao diện người dùng theo các kết quả tìm kiếm Danh sách này cũng sử dụng các hàm tiện ích từ util.js của DWR Có chú ý đặc biệt là hàm JavaScript có tên là $(), nó có thể được dùng như một phiên bản được cải tiến của document.getElementById() Tất nhiên là dễ dàng định kiểu hơn Nếu bạn đã
sử dụng thư viện JavaScript nguyên mẫu, bạn sẽ quen thuộc với hàm này
Liệt kê 3 Gọi phương thức findItems remoted () từ máy khách
/*
* Handles submission of the search form
*/
function searchFormSubmitHandler() {
// Obtain the search expression from the search field
var searchexp = $("searchbox").value;
// Call remoted DAO method, and specify callback function
catalog.findItems(searchexp, displayItems);
Trang 10// Return false to suppress form submission
}
}
Trang 11Trong hàm searchFormSubmitHandler() ở trên, tất nhiên mã quan tâm là
catalog.findItems(searchexp, displayItems); Một dòng mã này là tất cả những thứ cần thiết để gửi một XMLHttpRequest qua mạng tới DWR servlet và gọi hàm displayItems() với trả lời của đối tượng được truy cập từ xa
Hàm gọi lại displayItems() tự nó được gọi với một mảng của các thể hiện Item Mảng này được được chuyển qua tới hàm tiện ích DWRUtil.addRows() cùng với
mã nhận dạng (ID) của bảng cần điền vào và một mảng các hàm Càng có nhiều hàm trong mảng này thì càng có nhiều ô trong mỗi hàng của bảng Mỗi hàm được gọi lần lượt với một Item từ mảng đó và sẽ trả về nội dung để điền vào ô tương ứng
Trong trường hợp này, tôi muốn mỗi hàng trong bảng các mục hiển thị tên của
mục, mô tả và giá cả, cũng như một nút Add to Cart (Thêm vào giỏ hàng) cho
mục đó trong cột cuối Liệt kê 4 cho thấy mảng các hàm của ô thực hiện việc này:
Liệt kê 4 Mảng các hàm của ô để điền vào bảng các mục
/*
* Array of functions to populate a row of the items table
* using DWRUtil's addRows function
*/
var cellFunctions = [
function(item) { return item.name; },
function(item) { return item.description; },
function(item) { return item.formattedPrice; },
function(item) {
Trang 12mã nhận dạng của Item tới nút đó và xác định rằng một hàm có tên là
addToCartButtonHandler sẽ được gọi khi nút đó được nhấn Hàm này là điểm nhập vào cho trường hợp sử dụng thứ hai: thêm một Item vào giỏ mua hàng
DWR cũng hỗ trợ an ninh theo vai trò Bạn có thể xác định vai trò J2EE mà một người sử dụng đang truy cập một bean cụ thể thông qua cấu hình creator của nó Bằng cách triển khai nhiều cá thể URL được bảo mật của DWRServlet, mỗi cá thể
có tệp cấu hình dwr.xml riêng của nó, bạn cũng có thể cung cấp các tập hợp khác nhau của người dùng với chức năng được truy cập từ xa khác nhau
Trang 13Thể hiện Java của giỏ mua hàng của người dùng được dựa trên Map (Bản đồ) Khi một Item được thêm vào giỏ hàng này Item tự nó được chèn vào trong Map như là khoá Giá trị tương ứng trong Map là một Integer (số nguyên) thể hiện số lượng của Item cụ thể trong giỏ hàng này Vì vậy Cart.java có một trường,
contents (các nội dung), được khai báo như là Map<Item,Integer>
Việc sử dụng các kiểu phức tạp như là các khóa băm (hash key ) đặt ra vấn đề cho DWR trong JavaScript, các khóa mảng phải là các chữ Kết quả là contents Map
có thể không được DWR chuyển đổi như nó có Tuy nhiên, với các mục đích của giao diện người dùng của giỏ mua hàng, tất cả những thứ mà người sử dụng cần phải thấy là tên và số lượng của mỗi mục trong giỏ hàng này Vì vậy, tôi có thể thêm một phương thức có tên là getSimpleContents() vào Cart, có contents Map
và xây dựng một Map<String,Integer> đơn giản từ nó, thể hiện chỉ có tên và số lượng của mỗi Item Việc thể hiện bản đồ chuỗi có khóa này có thể đơn giản được các trình biến đổi gắn sẵn của DWR chuyển đổi thành JavaScript
Một trường khác của Cart mà máy khách có quan tâm đến là totalPrice, thể hiện tổng số của tất cả mọi thứ trong giỏ hàng Như với Item, tôi đã cung cấp một bộ phận tổng hợp có tên là formattedTotalPrice là một thể hiện String (Chuỗi) được định dạng sẵn của tổng số
Chuyển đổi giỏ hàng
Thay vì có mã khách hàng thực hiện hai cuộc gọi vào Cart, một để nhận được các nội dung và một cho giá tổng, tôi muốn gửi tất cả các dữ liệu này đến máy khách hàng cùng một lúc Để thực hiện điều này tôi đã thêm một phương thức mới lạ, hiển thị trong Liệt kê 5::
Liệt kê 5 Phương thức Cart.getCart ()
/**
* Returns the cart itself - for DWR
* @return the cart
*/
