當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

jersey客户端_项目学生：带有Jersey的Web服务客户端

發布時間：2023/12/3 编程问答 45 豆豆

生活随笔收集整理的這篇文章主要介紹了 jersey客户端_项目学生：带有Jersey的Web服务客户端小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

jersey客戶端

這是Project Student的一部分。其他職位包括帶有Jersey的Webservice Client，帶有Spring Data的業務層和持久性。

RESTful Web應用程序洋蔥的第一層是Web服務客戶端。它可以用于模仿包含AJAX內容的網頁，也可以被webapp的編程用戶用來模仿。注意，后者可能包括其他Web應用程序，例如，如果您的內部RESTful服務器被許多創建常規網頁的演示服務器包圍著。

設計決策

澤西島 -我使用澤西島庫進行REST調用。我考慮了幾種選擇，但決定選擇Jersey，因為它是輕量級的，不會對開發人員施加太多限制。相比之下，例如，使用Spring庫除了引入其他庫外，還可能在EJB3環境中引起問題。

UUID –數據庫將使用整數主鍵，但Web服務將使用UUID標識值。這是出于安全考慮–如果攻擊者知道帳戶ID 1008存在，那么可以肯定地說帳戶ID 1007存在。更重要的是，用戶ID 0可能存在并且具有比普通用戶更多的特權。

UUID并非如此-在大多數情況下，知道一個UUID并不能洞悉其他UUID。這不是100％準確的-一些UUID由IP地址或時間戳組成，因此，知識淵博的攻擊者可以極大地減少可能的值范圍-但是目前隨機UUID足夠“好”。

局限性

我采用的是“實現所需的最少功能”方法，因此初始實現存在許多限制。

身份驗證 –沒有嘗試提供身份驗證信息。

加密 –沒有嘗試加密Web服務調用。

僅CRUD方法 –僅支持基本CRUD方法。

請記住-限制很好，但是必須清楚地記錄在案。在最好的情況下，它們將被添加到敏捷積壓中。

客戶端API

客戶端API是基本的CRUD。我們稍后可以添加功能。

public interface CourseRestClient {/*** Get list of all courses.*/Course[] getAllCourses();/*** Get details for specific course.* @param uuid*/Course getCourse(String uuid);/*** Create specific course.* @param name*/Course createCourse(String name);/*** Update specific course.* @param uuid* @param name*/Course updateCourse(String uuid, String name);/*** Delete course.* @param uuid*/void deleteCourse(String uuid); }

例外情況

該API包括三個運行時異常。第一個是RestClientException，它是抽象的運行時異常，它是所有其他異常的基類。

缺少期望值時將引發ObjectNotFoundException。（實施說明：這是由404狀態代碼觸發的。）此異常包含足夠的信息以唯一地標識期望的對象。

public class ObjectNotFoundException extends RestClientException {private static final long serialVersionUID = 1L;private final String resource;private final Class<? extends PersistentObject> objectClass;private final String uuid;public ObjectNotFoundException(final String resource,final Class<? extends PersistentObject> objectClass,final String uuid) {super("object not found: " + resource + "[" + uuid + "]");this.resource = resource;this.objectClass = objectClass;this.uuid = uuid;}public String getResource() {return resource;}public Class<? extends PersistentObject> getObjectClass() {return objectClass;}public String getUuid() {return uuid;} }

RestClientFailureException是用于意外或未處理狀態代碼的通用處理程序。

public class RestClientFailureException extends RestClientException {private static final long serialVersionUID = 1L;private final String resource;private final Class<? extends PersistentObject> objectClass;private final String uuid;private final int statusCode;/*** Constructor* * @param resource* @param objectClass* @param uuid* @param response*/public RestClientFailureException(final String resource,final Class<? extends PersistentObject> objectClass,final String uuid, final ClientResponse response) {super("rest client received error: " + resource + "[" + uuid + "]");this.resource = resource;this.objectClass = objectClass;this.uuid = uuid;this.statusCode = response.getStatus();}public String getResource() {return resource;}public Class<? extends PersistentObject> getObjectClass() {return objectClass;}/*** Get UUID, "<none>" (during listAllX()) or "(name)" (during createX())* * @return*/public String getUuid() {return uuid;}/*** Get standard HTTP status code.* * @return*/public int getStatusCode() {return statusCode;} }

添加客戶端身份驗證后，我們希望添加UnauthorizedOperationException。

客戶實施

基本的CRUD實現通常是樣板，因此我們可以使用抽象類來完成大部分繁重的工作。更多高級功能可能需要此類來直接進行Jersey呼叫。

/*** This is the Course-specific implementation.*/ public class CourseRestClientImpl extends AbstractRestClientImpl<Course>implements CourseRestClient {private static final Course[] EMPTY_COURSE_ARRAY = new Course[0];/*** Constructor.* * @param courseResource*/public CourseRestClientImpl(final String resource) {super(resource, Course.class, Course[].class);}/*** Create JSON string.* * @param name* @return*/String createJson(final String name) {return String.format("{ \"name\": \"%s\" }", name);}/*** @see com.invariantproperties.sandbox.student.webservice.client.CourseRestClient#getAllCourses()*/public Course[] getAllCourses() {return super.getAllObjects(EMPTY_COURSE_ARRAY);}/*** @see com.invariantproperties.sandbox.student.webservice.client.CourseRestClient#getCourse(java.lang.String)*/public Course getCourse(final String uuid) {return super.getObject(uuid);}/*** @see com.invariantproperties.sandbox.student.webservice.client.CourseRestClient#createCourse(java.lang.String)*/public Course createCourse(final String name) {if (name == null || name.isEmpty()) {throw new IllegalArgumentException("'name' is required");}return createObject(createJson(name));}/*** @see com.invariantproperties.sandbox.student.webservice.client.CourseRestClient#updateCourse(java.lang.String,* java.lang.String)*/public Course updateCourse(final String uuid, final String name) {if (name == null || name.isEmpty()) {throw new IllegalArgumentException("'name' is required");}return super.updateObject(createJson(name), uuid);}/*** @see com.invariantproperties.sandbox.student.webservice.client.CourseRestClient#deleteCourse(java.lang.String)*/public void deleteCourse(final String uuid) {super.deleteObject(uuid);} }

抽象基類進行繁重的工作。

public class AbstractRestClientImpl<T extends PersistentObject> {private final String resource;private final Class<T> objectClass;private final Class<T[]> objectArrayClass;/*** Constructor.* * @param resource*/public AbstractRestClientImpl(final String resource,final Class<T> objectClass, final Class<T[]> objectArrayClass) {this.resource = resource;this.objectClass = objectClass;this.objectArrayClass = objectArrayClass;}/*** Helper method for testing.* * @return*/Client createClient() {return Client.create();}/*** List all objects. This is a risky method since there's no attempt at* pagination.*/public T[] getAllObjects(final T[] emptyListClass) {final Client client = createClient();try {final WebResource webResource = client.resource(resource);final ClientResponse response = webResource.accept(MediaType.APPLICATION_JSON).get(ClientResponse.class);if (response.getStatus() == Response.Status.OK.getStatusCode()) {T[] entities = response.getEntity(objectArrayClass);return entities;} else {throw new RestClientFailureException(resource, objectClass,"<none>", response);}} finally {client.destroy();}}/*** Get a specific object.*/public T getObject(String uuid) {final Client client = createClient();try {final WebResource webResource = client.resource(resource + uuid);final ClientResponse response = webResource.accept(MediaType.APPLICATION_JSON).get(ClientResponse.class);if (response.getStatus() == Response.Status.OK.getStatusCode()) {final T entity = response.getEntity(objectClass);return entity;} else if (response.getStatus() == Response.Status.NOT_FOUND.getStatusCode()) {throw new ObjectNotFoundException(resource, objectClass, uuid);} else {throw new RestClientFailureException(resource, objectClass,uuid, response);}} finally {client.destroy();}}/*** Create an object with the specified values.*/public T createObject(final String json) {final Client client = createClient();try {final WebResource webResource = client.resource(resource);final ClientResponse response = webResource.type(MediaType.APPLICATION_JSON).accept(MediaType.APPLICATION_JSON).post(ClientResponse.class, json);if (response.getStatus() == Response.Status.CREATED.getStatusCode()) {final T entity = response.getEntity(objectClass);return entity;} else {throw new RestClientFailureException(resource, objectClass, "("+ json + ")", response);}} finally {client.destroy();}}/*** Update an object with the specified json.*/public T updateObject(final String json, final String uuid) {final Client client = createClient();try {final WebResource webResource = client.resource(resource + uuid);final ClientResponse response = webResource.type(MediaType.APPLICATION_JSON).accept(MediaType.APPLICATION_JSON).post(ClientResponse.class, json);if (response.getStatus() == Response.Status.OK.getStatusCode()) {final T entity = response.getEntity(objectClass);return entity;} else if (response.getStatus() == Response.Status.NOT_FOUND.getStatusCode()) {throw new ObjectNotFoundException(resource, objectClass, uuid);} else {throw new RestClientFailureException(resource, objectClass,uuid, response);}} finally {client.destroy();}}/*** Delete specified object.*/public void deleteObject(String uuid) {final Client client = createClient();try {final WebResource webResource = client.resource(resource + uuid);final ClientResponse response = webResource.accept(MediaType.APPLICATION_JSON).delete(ClientResponse.class);if (response.getStatus() == Response.Status.GONE.getStatusCode()) {// do nothing} else if (response.getStatus() == Response.Status.NOT_FOUND.getStatusCode()) {// do nothing - delete is idempotent} else {throw new RestClientFailureException(resource, objectClass,uuid, response);}} finally {client.destroy();}} }

單元測試

現在我們來看看我們的測試代碼。重要提示：我們要測試代碼的行為，而不是代碼的實現。

public class CourseRestClientImplTest {private static final String UUID = "uuid";private static final String NAME = "name";@Testpublic void testGetAllCoursesEmpty() {CourseRestClient client = new CourseRestClientMock(200, new Course[0]);Course[] results = client.getAllCourses();assertEquals(0, results.length);}@Testpublic void testGetAllCoursesNonEmpty() {Course course = new Course();course.setUuid(UUID);CourseRestClient client = new CourseRestClientMock(200,new Course[] { course });Course[] results = client.getAllCourses();assertEquals(1, results.length);}@Test(expected = RestClientFailureException.class)public void testGetAllCoursesError() {CourseRestClient client = new CourseRestClientMock(500, null);client.getAllCourses();}@Testpublic void testGetCourse() {Course course = new Course();course.setUuid(UUID);CourseRestClient client = new CourseRestClientMock(200, course);Course results = client.getCourse(course.getUuid());assertEquals(course.getUuid(), results.getUuid());}@Test(expected = ObjectNotFoundException.class)public void testGetCourseMissing() {CourseRestClient client = new CourseRestClientMock(404, null);client.getCourse(UUID);}@Test(expected = RestClientFailureException.class)public void testGetCourseError() {CourseRestClient client = new CourseRestClientMock(500, null);client.getCourse(UUID);}@Testpublic void testCreateCourse() {Course course = new Course();course.setName(NAME);CourseRestClient client = new CourseRestClientMock(Response.Status.CREATED.getStatusCode(), course);Course results = client.createCourse(course.getName());assertEquals(course.getName(), results.getName());}@Test(expected = RestClientFailureException.class)public void testCreateCourseError() {CourseRestClient client = new CourseRestClientMock(500, null);client.createCourse(UUID);}@Testpublic void testUpdateCourse() {Course course = new Course();course.setUuid(UUID);course.setName(NAME);CourseRestClient client = new CourseRestClientMock(200, course);Course results = client.updateCourse(course.getUuid(), course.getName());assertEquals(course.getUuid(), results.getUuid());assertEquals(course.getName(), results.getName());}@Test(expected = ObjectNotFoundException.class)public void testUpdateCourseMissing() {CourseRestClient client = new CourseRestClientMock(404, null);client.updateCourse(UUID, NAME);}@Test(expected = RestClientFailureException.class)public void testUpdateCourseError() {CourseRestClient client = new CourseRestClientMock(500, null);client.updateCourse(UUID, NAME);}@Testpublic void testDeleteCourse() {Course course = new Course();course.setUuid(UUID);CourseRestClient client = new CourseRestClientMock(Response.Status.GONE.getStatusCode(), null);client.deleteCourse(course.getUuid());}@Testpublic void testDeleteCourseMissing() {CourseRestClient client = new CourseRestClientMock(404, null);client.deleteCourse(UUID);}@Test(expected = RestClientFailureException.class)public void testDeleteCourseError() {CourseRestClient client = new CourseRestClientMock(500, null);client.deleteCourse(UUID);} }

最后，我們需要使用模擬的REST客戶端創建一個要測試的對象。由于Client.createClient是靜態方法，因此無法使用依賴項注入，但是我們已將該調用包裝在可以覆蓋的package-private方法中。該方法將創建一個模擬的客戶端，該客戶端提供Jersey庫中所需的其余值。

class CourseRestClientMock extends CourseRestClientImpl {static final String RESOURCE = "test://rest/course/";private Client client;private WebResource webResource;private WebResource.Builder webResourceBuilder;private ClientResponse response;private final int status;private final Object results;CourseRestClientMock(int status, Object results) {super(RESOURCE);this.status = status;this.results = results;}/*** Override createClient() so it returns mocked object. These expectations* will handle basic CRUD operations, more advanced functionality will* require inspecting JSON payload of POST call.*/Client createClient() {client = Mockito.mock(Client.class);webResource = Mockito.mock(WebResource.class);webResourceBuilder = Mockito.mock(WebResource.Builder.class);response = Mockito.mock(ClientResponse.class);when(client.resource(any(String.class))).thenReturn(webResource);when(webResource.accept(any(String.class))).thenReturn(webResourceBuilder);when(webResource.type(any(String.class))).thenReturn(webResourceBuilder);when(webResourceBuilder.accept(any(String.class))).thenReturn(webResourceBuilder);when(webResourceBuilder.type(any(String.class))).thenReturn(webResourceBuilder);when(webResourceBuilder.get(eq(ClientResponse.class))).thenReturn(response);when(webResourceBuilder.post(eq(ClientResponse.class),any(String.class))).thenReturn(response);when(webResourceBuilder.put(eq(ClientResponse.class),any(String.class))).thenReturn(response);when(webResourceBuilder.delete(eq(ClientResponse.class))).thenReturn(response);when(response.getStatus()).thenReturn(status);when(response.getEntity(any(Class.class))).thenReturn(results);return client;} }

整合測試

這是洋蔥的最外層，因此沒有有意義的集成測試。

源代碼

可從http://code.google.com/p/invariant-properties-blog/source/browse/student/student-webservices/student-ws-client獲取源代碼。

參考：項目學員：來自Invariant Properties博客的JCG合作伙伴 Bear Giles的澤西Web服務客戶端。

翻譯自: https://www.javacodegeeks.com/2013/12/project-student-webservice-client-with-jersey.html