用Jersey爲Android客戶端開發Restful Web Service
平時在作Android客戶端的時候常常要與服務器之間通訊，客戶端經過服務端提供的接口獲取數據，而後再展現在客戶端的界面上，做爲Android開發者，咱們平時更多的是關注客戶端的開發，而對服務端開發的關注相對較少，可是若是咱們要本身一我的設計並開發一套完整的系統，咱們就必須同時具有客戶端和服務端的開發知識，並且我認爲同時掌握客戶端和服務端的開發技術仍是頗有用處的，不只有助於提高咱們的架構知識和能力，並且還……你懂得！身邊一些作WEB開發的朋友不少都說爲客戶端開發接口和單純地作WEB項目並無很大的區別，無論後臺語言用的是JAVA，PHP，仍是C#等，用這些語言爲客戶端開發接口的時候有不少類似之處，好比說服務端請求路徑的分發以及請求處理方式等。這幾天出於好奇，想爲本身的客戶端開發Web Service接口，因此就在網上搜集了一些資料，發現有不少WEB框架能夠很輕鬆地爲移動端開發服務器接口，好比說Spring MVC，CXF，AXIS，RESTEasy等等，可是我最終選用了Jersey來完成服務端的開發。html
首先，咱們來大體說一下Jersey是什麼。按照Jersey官網（https://jersey.java.net/）的介紹，Jersey是在Java開發中，爲了簡化RESTful Web Service以及客戶端開發而設計的一套開源的，標準的，很優秀的，使用起來很是方便的JAX-RS API（即Java API for RESTful Web Services），Jersey支持JAX-RS API，而且是JAX-RS (JSR 311 & JSR 339) 的參考實現，值得注意的是，Jersey不只僅是JAX-RS的參考實現，同時，它在JAX-RS工具包的基礎上作了大量的擴展，增長了許多額外的特性和工具，而且都提供了豐富的說明文檔以便開發者進一步對Jessey進行擴展以知足本身的實際開發需求。
java
爲了方便你們更好地理解JAX-RS和RESTful，在這裏我對這兩個名詞稍加說明。android
JAX-RS按照百度百科上面的說明，即Java API for RESTful Web Services，是一個Java 編程語言的應用程序接口，支持按照表述性狀態轉移（REST）架構風格建立Web服務。JAX-RS使用了Java SE5引入的Java標註來簡化Web服務的客戶端和服務端的開發和部署。JAX-RS提供了一些標註將一個資源類，一個POJO Java類，封裝爲Web資源。JAX-RS包含了一系列的標註，包括：git
@Path，標註資源類或者方法的相對路徑
@GET，@PUT，@POST，@DELETE，標註方法是HTTP請求的類型。
@Produces，標註返回的MIME媒體類型
@Consumes，標註可接受請求的MIME媒體類型
@PathParam，@QueryParam，@HeaderParam，@CookieParam，@MatrixParam，@FormParam,分別標註方法的參數來自於HTTP請求的不一樣位置，例如@PathParam來自於URL的路徑，@QueryParam來自於URL的查詢參數，@HeaderParam來自於HTTP請求的頭信息，@CookieParam來自於HTTP請求的Cookie。
RESTful是一種軟件架構風格，而不是軟件設計標準，只是提供了一組設計原則和約束條件。它主要用於客戶端和服務器交互類的軟件。基於這個風格設計的軟件能夠更簡潔，更有層次，更易於實現緩存等機制。關於RESTful的詳細信息請參考：http://baike.baidu.com/link?url=z4989VJ3yaALLF9Xs7yc-j7h9QjKjDLGMz12F-ORdWpNjawQE6oOVLVXdnCh4OW1Pla7DJBpy6NlhwuzI1LUAK。
好了，廢話很少說，接下來立刻開始咱們的實戰階段，我將經過寫一個服務端項目和一個Android客戶端項目來詳細說明是如何使用Jersey實現爲移動端開發Web Service的。
第一步，簡單介紹一下項目的需求，咱們將開發一個APP登陸模塊，登陸以後進入首頁，首頁顯示歡迎語和登陸用戶的名字，首頁中有一個Button，經過點擊Button獲取到服務器中保存的全部用戶的信息並經過TextView展現，需求就是這麼簡單，邏輯也不會很複雜。我但願就是經過這麼一個簡單的模型讓對服務端接口開發還不是很熟悉的朋友瞭解到經過Jersey如何實現服務端的開發，以及客戶端和服務端是如何交互。
第二步，介紹一下使用到的開發工具，服務端我用的是MyEclipse 2015，客戶端使用的是Android Studio。
第三步，說明一下客戶端和服務端通訊數據傳輸格式爲JSON，客戶端在解析服務端返回的json時使用了谷歌自家的工具Gson。對於簡單的JSON，咱們使用普通的JsonArray和JsonObject能夠很方便的解析，不必使用Gson等解析工具，可是在解析一些很是複雜的json的時候，Gson等解析工具的優點就會體現出來了，Gosn可以很方便的將json轉換爲實體Bean，也能很方便地將實體Bean轉換爲json，這對於作WEB API開發很是有幫助，省去了很多解析的麻煩，所以我我的向你們推薦學習一下Gson的使用。此外，客戶端採用HttpURLConnection向服務端發送請求，請求方式爲POST，請求內容的類型（Content-Type）爲application/x-www-form-urlencoded，並設置請求鏈接服務器的超時時間爲5秒。
第四步，服務端項目編寫：
服務端須要使用到不少jar包，包括Jersey官方提供的衆多jar包，以及註冊json轉化器須要使用到的JackSon項目jar包，JackSon的做用基本和Gson相似，用於java中java bean和json或者xml之間的轉換。Jersey官方的jar包的下載地址：https://jersey.java.net/download.html。我在項目中使用的是Jesey2.x版本，你們在使用的時候下載最新版的就能夠，固然也能夠直接拷貝項目中的全部jar包到本身的項目中。JackSon的官網貌似如今不能下載jar包了，可是應該有其它一些渠道能夠下載，你們在使用的時候能夠直接拷貝我丟在項目中的jar包。
首先，咱們須要建立一個動態Web工程，即Dynamic Web Project，具體建立步驟以下：
File-New-Other
選擇Dynamic Web Project，點擊next
給項目取名，其它默認，點擊finish。
工程建立好以後，咱們看一下項目完成以後的總體結構，如圖：
其中，核心代碼在RestService.java中,全部的接口都寫在這裏面，我直接把RestService.java的代碼貼出來，以下：
1 package com.jerseyserver.service; 2 3 4 import java.util.ArrayList; 5 import java.util.HashMap; 6 7 import javax.ws.rs.FormParam; 8 import javax.ws.rs.GET; 9 import javax.ws.rs.POST; 10 import javax.ws.rs.Path; 11 import javax.ws.rs.Produces; 12 import javax.ws.rs.core.GenericEntity; 13 import javax.ws.rs.core.MediaType; 14 import javax.ws.rs.core.Response; 15 16 import com.fasterxml.jackson.core.JsonProcessingException; 17 import com.fasterxml.jackson.databind.ObjectMapper; 18 import com.jerseyserver.entity.ResponseDTO; 19 import com.jerseyserver.entity.User; 20 import com.jerseyserver.util.TextUtil; 21 22 23 @Path("/restService") 24 public class RestService { 25 @POST 26 @Path("/getUserText") 27 @Produces(MediaType.TEXT_PLAIN) 28 /** 29 * 測試返回text文本媒體類型數據的方式 30 * @return "Hello,World!" 31 */ 32 public String getUserText() { 33 return "Hello,World!"; 34 } 35 36 @GET 37 @Path("/getUserXml") 38 @Produces(MediaType.APPLICATION_XML) 39 /** 40 * 測試返回xml媒體類型數據的方式 41 * @return User object 42 */ 43 public User getUserXml() { 44 User user = new User(); 45 user.setName("snail"); 46 user.setAge("22"); 47 user.setSex("male"); 48 return user; 49 } 50 51 @GET 52 @Path("/getUserJson") 53 @Produces(MediaType.APPLICATION_JSON) 54 /** 55 * 測試返回json媒體類型數據的方式 56 * @return User object 57 */ 58 public User getUserJson() { 59 User user = new User(); 60 user.setName("snail"); 61 user.setAge("22"); 62 user.setSex("male"); 63 return user; 64 } 65 66 @POST 67 @Path("/getUserInfo") 68 @Produces(MediaType.APPLICATION_JSON) 69 /** 70 * 測試帶請求參數時返回json媒體類型數據的方式 71 * @param username 72 * @return 73 */ 74 public User getUserInfo(@FormParam("username") String username) { 75 if (username == null || "".equals(username)) { 76 return null; 77 } 78 return getUserByName(username); 79 } 80 81 /** 82 * 經過用戶名獲取用戶 83 * @param username 84 * @return User object 85 */ 86 private User getUserByName(String username) { 87 HashMap<String, User> map = initAllUsers(); 88 return map.get(username); 89 } 90 91 /** 92 * 獲取全部用戶的map 93 * @return 全部用戶的map 94 */ 95 private HashMap<String, User> initAllUsers() { 96 HashMap<String, User> map = new HashMap<>(); 97 98 User user1 = new User(); 99 user1.setName("Jack"); 100 user1.setPasswd("Jack"); 101 user1.setAge(18 + ""); 102 user1.setSex("男"); 103 map.put(user1.getName(), user1); 104 105 User user2 = new User(); 106 user2.setName("Alice"); 107 user2.setPasswd("Alice"); 108 user2.setAge(18 + ""); 109 user2.setSex("女"); 110 map.put(user2.getName(), user2); 111 112 User user3 = new User(); 113 user3.setName("Allen"); 114 user3.setPasswd("Allen"); 115 user3.setAge(20 + ""); 116 user3.setSex("女"); 117 map.put(user3.getName(), user3); 118 119 return map; 120 } 121 122 @POST 123 @Path("/login") 124 @Produces(MediaType.APPLICATION_JSON) 125 /** 126 * 用戶登陸 127 * @param username 用戶名 128 * @param password 密碼 129 * @return Response object 130 */ 131 public Response login(@FormParam("username") String username, @FormParam("password") String password) { 132 if (TextUtil.isEmpty(username) || TextUtil.isEmpty(password)) { 133 return null; 134 } 135 User user = checkUser(username, password); 136 if (user == null) { 137 return null; 138 } 139 140 ObjectMapper mapper = new ObjectMapper(); 141 142 GenericEntity<String> payloadEntity; 143 try { 144 payloadEntity = new GenericEntity<String>( 145 mapper.writeValueAsString(new ResponseDTO(200, "ok", user))) { 146 }; 147 return Response.ok(payloadEntity).build(); 148 } catch (JsonProcessingException e) { 149 e.printStackTrace(); 150 return Response 151 .ok(" {\"status\": 404,\n\"message\": \"error\",\n\"response\": \"\"}") 152 .build(); 153 } 154 } 155 156 /** 157 * 驗證用戶是否存在 158 * @param username 159 * @param password 160 * @return User object 161 */ 162 private User checkUser(String username, String password) { 163 HashMap<String, User> map = initAllUsers(); 164 User user = map.get(username); 165 if (user != null) { 166 String passwd = user.getPasswd(); 167 if (password.equals(passwd)) { 168 return user; 169 } 170 } 171 return null; 172 } 173 174 @POST 175 @Path("/getAllUsers") 176 @Produces(MediaType.APPLICATION_JSON) 177 /** 178 * 獲取全部用戶的集合 179 * @return Response object 180 */ 181 public Response getAllUsers() { 182 ArrayList<User> list = new ArrayList<User>(); 183 User user1 = new User(); 184 user1.setName("Jack"); 185 user1.setPasswd("Jack"); 186 user1.setAge(18 + ""); 187 user1.setSex("男"); 188 list.add(user1); 189 190 User user2 = new User(); 191 user2.setName("Alice"); 192 user2.setPasswd("Alice"); 193 user2.setAge(18 + ""); 194 user2.setSex("女"); 195 list.add(user2); 196 197 User user3 = new User(); 198 user3.setName("Allen"); 199 user3.setPasswd("Allen"); 200 user3.setAge(20 + ""); 201 user3.setSex("女"); 202 list.add(user3); 203 204 ObjectMapper mapper = new ObjectMapper(); 205 206 GenericEntity<String> payloadEntity; 207 try { 208 payloadEntity = new GenericEntity<String>( 209 mapper.writeValueAsString(new ResponseDTO(200, "ok", list))) { 210 }; 211 return Response.ok(payloadEntity).build(); 212 } catch (JsonProcessingException e) { 213 e.printStackTrace(); 214 return Response 215 .ok(" {\"status\": 404,\n\"message\": \"error\",\n\"response\": \"\"}") 216 .build(); 217 } 218 } 219 }
咱們能夠看到，類和接口方法均有註解，這些註解是必須寫上去的，由於這些註解指定了一些很關鍵的信息，客戶端請求的時候必須依賴這些註解才能最終找到請求的接口，而後經過接口獲取數據並返回。RestService.java上面的註解@Path("/restService")指定了Web Service接口的轉發路徑，每個接口方法上面有三個註解，其中，@POST和@GET等表示網絡請求方式，請求方式除了@POST和@GET以外，常見的還有put、delete等；@Path("/getUserText")、@Path("/getUserXml")、@Path("/getUserJson")表示的是請求的接口的路徑，與類的@Path註解和項目目錄一塊兒拼接組成完整的請求路徑，@Path註解後面的名字能夠按照命名規範本身取；@Produces指定了請求的數據格式，通常爲JSON和XML，固然還有TEXT文檔等類型。這些註解都指定好以後，那麼客戶端就能夠經過完整的請求路徑來訪問服務器了，完整的路徑格式爲：http://[IP地址]:[端口號]/[服務端工程名]/[路徑映射]/[接口類路徑]/[接口方法路徑]，例如，客戶端要訪問咱們項目中的login接口，那麼客戶端請求的完整路徑爲：http://192.168.254.26:8080/JerseyServer/rest/restService/login，192.168.254.26是我電腦的局域網IP地址，8080爲訪問apache的端口號，rest是在web.xml中配置的路徑映射名。web.xml的配置內容以下：github
1 <?xml version="1.0" encoding="UTF-8"?> 2 <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd"> 3 <web-app id="WebApp_ID"> 4 <!-- 同項目名 --> 5 <display-name>JerseyServer</display-name> 6 <servlet> 7 <!-- 爲servlet取名 --> 8 <servlet-name>mobile</servlet-name> 9 <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class> 10 <init-param> 11 <param-name>javax.ws.rs.Application</param-name> 12 <!-- 配置本身的資源加載類，用於加載資源 --> 13 <param-value>com.jerseyserver.RestApplication</param-value> 14 </init-param> 15 <load-on-startup>1</load-on-startup> 16 </servlet> 17 <servlet-mapping> 18 <!-- 保持和servlet名一致 --> 19 <servlet-name>mobile</servlet-name> 20 <!-- 分發根路徑，用來作路徑映射--> 21 <url-pattern>/rest/*</url-pattern> 22 </servlet-mapping> 23 <welcome-file-list> 24 <welcome-file>index.html</welcome-file> 25 <welcome-file>index.htm</welcome-file> 26 <welcome-file>index.jsp</welcome-file> 27 <welcome-file>default.html</welcome-file> 28 <welcome-file>default.htm</welcome-file> 29 <welcome-file>default.jsp</welcome-file> 30 </welcome-file-list> 31 </web-app>
web.xml中須要注意的項已經標註在了註釋裏面，其中有一個資源加載類RestApplication.java用於加載各類資源和所需工具，代碼以下：web
1 package com.jerseyserver; 2 3 import org.glassfish.jersey.filter.LoggingFilter; 4 import org.glassfish.jersey.server.ResourceConfig; 5 6 import com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider; 7 8 public class RestApplication extends ResourceConfig { 9 public RestApplication() { 10 // 服務類所在的包路徑 11 packages("com.jerseyserver.service"); 12 // 註冊JSON轉換器 13 register(JacksonJsonProvider.class); 14 // 打印訪問日誌，便於跟蹤調試，正式發佈可清除 15 register(LoggingFilter.class); 16 } 17 }
這裏，主要指定了服務類的包路徑，並用Jackson做爲Json的解析轉換工具，用glassfish的LoggingFilter打印日誌。apache
此外，項目中的User實體類代碼以下：編程
1 package com.jerseyserver.entity; 2 3 import javax.xml.bind.annotation.XmlRootElement; 4 5 @XmlRootElement 6 public class User { 7 private String name; 8 private String passwd; 9 private String age; 10 private String sex; 11 public String getName() { 12 return name; 13 } 14 public void setName(String name) { 15 this.name = name; 16 } 17 public String getPasswd() { 18 return passwd; 19 } 20 public void setPasswd(String passwd) { 21 this.passwd = passwd; 22 } 23 public String getAge() { 24 return age; 25 } 26 public void setAge(String age) { 27 this.age = age; 28 } 29 public String getSex() { 30 return sex; 31 } 32 public void setSex(String sex) { 33 this.sex = sex; 34 } 35 }
注意，須要用@XmlRootElement進行註釋才能正常傳遞實體數據。json
ResponseDTO.java用於包裝返回給客戶端的JSON數據，包括返回狀態碼，返回狀態值以及實體數據，代碼以下：緩存
1 package com.jerseyserver.entity; 2 3 public class ResponseDTO { 4 private int status; 5 private String message; 6 private Object response; 7 8 public ResponseDTO(int status, String message, Object response) { 9 super(); 10 this.status = status; 11 this.message = message; 12 this.response = response; 13 } 14 15 public int getStatus() { 16 return status; 17 } 18 19 public void setStatus(int status) { 20 this.status = status; 21 } 22 23 public String getMessage() { 24 return message; 25 } 26 27 public void setMessage(String message) { 28 this.message = message; 29 } 30 31 public Object getResponse() { 32 return response; 33 } 34 35 public void setResponse(Object response) { 36 this.response = response; 37 } 38 }
好了，到此服務端就搞定了，接下來讓咱們簡單看看android端的實現。客戶端的項目結構以下：
客戶端與服務器鏈接的部分以及各個接口都在WebService.java中，實現代碼以下：
1 package com.jy.jerseyclient.service; 2 3 import android.text.TextUtils; 4 import android.util.Log; 5 6 import com.jy.jerseyclient.entity.Response; 7 import com.jy.jerseyclient.utils.JsonUtil; 8 9 import java.io.ByteArrayOutputStream; 10 import java.io.InputStream; 11 import java.io.OutputStream; 12 import java.net.HttpURLConnection; 13 import java.net.URL; 14 import java.net.URLEncoder; 15 import java.util.HashMap; 16 import java.util.Map; 17 18 /** 19 * Created by xy on 2016/4/10. 20 */ 21 public class WebService { 22 private final static String TAG = "WebService"; 23 /**服務器接口根路徑*/ 24 private static final String WEB_ROOT = "http://192.168.254.26:8080/JerseyServer/rest/restService/"; 25 /**登陸*/ 26 private static final String LOGIN = "login"; 27 /**獲取全部用戶信息*/ 28 private static final String GET_ALL_USERS = "getAllUsers"; 29 30 /** 31 * 登陸 32 * @param username 用戶名 33 * @param password 用戶密碼 34 * @return 包含用戶信息的Response對象 35 */ 36 public static Response login(String username, String password) { 37 String path = WEB_ROOT + LOGIN; 38 Map<String, String> map = new HashMap<>(); 39 map.put("username", username); 40 map.put("password", password); 41 InputStream is = connection(path, map); 42 if (is != null) { 43 String content = getStringFromIS(is); 44 if (content != null) { 45 return parseResponse(content); 46 } else { 47 Log.e(TAG, "contentS == null"); 48 } 49 } else { 50 Log.e(TAG, "is == null"); 51 } 52 return null; 53 } 54 55 /** 56 * 獲取全部用戶信息 57 * @return 包含全部用戶信息的Response對象 58 */ 59 public static Response getAllUsers() { 60 String path = WEB_ROOT + GET_ALL_USERS; 61 InputStream is = connection(path, null); 62 if (is != null) { 63 String content = getStringFromIS(is); 64 if (content != null) { 65 return parseResponse(content); 66 } else { 67 Log.e(TAG, "contentS == null"); 68 } 69 } else { 70 Log.e(TAG, "is == null"); 71 } 72 return null; 73 } 74 75 /** 76 * 解析服務器返回的JSON數據 77 * @param content JSON數據 78 * @return Response對象 79 */ 80 private static Response parseResponse(String content) { 81 Log.e(TAG, "state======" + content); 82 if (TextUtils.isEmpty(content)) { 83 return null; 84 } 85 return JsonUtil.getEntity(content, Response.class); 86 } 87 88 /** 89 * 獲得服務器返回的輸入流數據 90 * @param path 請求路徑 91 * @param map 包含密文的map集合 92 * @return 服務器返回的數據 93 */ 94 private static InputStream connection(String path, Map<String, String> map) { 95 try { 96 String pathUrl = path; 97 URL url = new URL(pathUrl); 98 HttpURLConnection httpConn = (HttpURLConnection) url.openConnection(); 99 StringBuffer sb = new StringBuffer(); 100 if (map != null) { 101 if (!map.isEmpty()) { 102 for (Map.Entry<String, String> entry : map.entrySet()) { 103 sb.append(entry.getKey()).append('=').append(URLEncoder.encode(entry.getValue(), "UTF-8")).append('&'); 104 } 105 sb.deleteCharAt(sb.length() - 1); 106 } 107 } 108 byte[] entityData = sb.toString().getBytes(); 109 httpConn.setDoOutput(true); 110 httpConn.setDoInput(true); 111 httpConn.setUseCaches(false); 112 httpConn.setRequestMethod("POST"); 113 //設置請求服務器鏈接的超時時間 114 httpConn.setConnectTimeout(5 * 1000); 115 //設置服務器返回數據的超時時間 116 //httpConn.setReadTimeout(30 * 1000); 117 httpConn.setRequestProperty("Content-length", "" + entityData.length); 118 httpConn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); 119 OutputStream outStream = httpConn.getOutputStream(); 120 outStream.write(entityData); 121 outStream.flush(); 122 outStream.close(); 123 int responseCode = httpConn.getResponseCode(); 124 if (HttpURLConnection.HTTP_OK == responseCode) { 125 InputStream is = httpConn.getInputStream(); 126 return is; 127 } 128 } catch (Exception ex) { 129 ex.printStackTrace(); 130 return null; 131 } 132 return null; 133 } 134 135 /** 136 * 將服務器返回的輸入流轉換爲字符串 137 * @param is 服務器返回的輸入流 138 * @return 輸入流轉換以後的字符串 139 */ 140 public static String getStringFromIS(InputStream is) { 141 byte[] buffer = new byte[1024]; 142 ByteArrayOutputStream os = new ByteArrayOutputStream(); 143 try { 144 int len = -1; 145 while ((len = is.read(buffer)) != -1) { 146 os.write(buffer, 0, len); 147 } 148 os.close(); 149 is.close(); 150 } catch (Exception e) { 151 e.printStackTrace(); 152 } 153 String reString = new String(os.toByteArray()); 154 155 Log.e(TAG, "geStringFromIS reString======" + reString); 156 157 return reString; 158 } 159 }
其中，使用HttpURLConnection向服務器發送請求數據，用GSON來解析JSON數據，在解析JSON的時候，爲了解析的方便，我對GSON進行了進一步封裝，以便在接口中對全部的實體和JSON進行統一的轉換，其實現代碼以下：
1 package com.jy.jerseyclient.utils; 2 3 import android.util.Log; 4 5 import com.google.gson.Gson; 6 import com.google.gson.JsonArray; 7 import com.google.gson.JsonElement; 8 import com.google.gson.JsonParser; 9 10 import java.util.ArrayList; 11 import java.util.List; 12 13 /** 14 * Created by xy on 2015/12/29. 15 */ 16 public class JsonUtil { 17 private final static String TAG = "JsonUtil"; 18 /** 19 * 將對象轉換爲json字符串 20 * @param obj 對象，能夠是實體對象，List對象，Map對象等 21 * @return json字符串 22 */ 23 public static String toJson(Object obj) { 24 if (obj == null) { 25 throw new IllegalArgumentException("illegal argument"); 26 } 27 28 return new Gson().toJson(obj); 29 } 30 31 /** 32 * 將json字符串轉換爲實體對象 33 * @param jsonString json字符串 34 * @param cls 實體類 35 * @param <T> 泛型參數 36 * @return 實體對象 37 */ 38 public static <T> T getEntity(String jsonString, final Class<T> cls) { 39 T t; 40 try { 41 Gson gson = new Gson(); 42 t = gson.fromJson(jsonString, cls); 43 } catch (Exception e) { 44 e.printStackTrace(); 45 Log.e(TAG, jsonString + " 沒法轉換爲 " + cls.getSimpleName() + " 對象"); 46 return null; 47 } 48 49 return t; 50 } 51 52 /** 53 * 將json字符串轉換爲List對象 54 * @param jsonString json字符串 55 * @param cls 實體類 56 * @param <T> 泛型參數 57 * @return 實體List對象 58 */ 59 public static <T> List<T> getEntityList(String jsonString, final Class<T> cls) { 60 List<T> list = new ArrayList<T>(); 61 62 JsonArray array = new JsonParser().parse(jsonString).getAsJsonArray(); 63 64 for (final JsonElement elem : array) { 65 list.add(new Gson().fromJson(elem, cls)); 66 } 67 68 return list; 69 } 70 }
同服務端同樣，客戶端也用一個Response類封裝實體對象的信息。
Response.java的代碼以下：
1 package com.jy.jerseyclient.entity; 2 3 import java.io.Serializable; 4 5 /** 6 * Description: 7 * Author: xy 8 * Date: 2016/4/12 14:49 9 */ 10 public class Response implements Serializable { 11 private static final long serialVersionUID = 8980216391057926016L; 12 public int status; 13 public String message; 14 public Object response; 15 16 public int getStatus() { 17 return status; 18 } 19 20 public void setStatus(int status) { 21 this.status = status; 22 } 23 24 public String getMessage() { 25 return message; 26 } 27 28 public void setMessage(String message) { 29 this.message = message; 30 } 31 32 public Object getResponse() { 33 return response; 34 } 35 36 public void setResponse(Object response) { 37 this.response = response; 38 } 39 }
User.java的代碼以下：
1 package com.jy.jerseyclient.entity; 2 3 import java.io.Serializable; 4 5 /** 6 * Created by 123 on 2016/4/10. 7 */ 8 public class User implements Serializable { 9 private static final long serialVersionUID = -1044671445753823751L; 10 private String name; 11 private String passwd; 12 private String sex; 13 private String age; 14 15 public String getName() { 16 return name; 17 } 18 19 public void setName(String name) { 20 this.name = name; 21 } 22 23 public String getPasswd() { 24 return passwd; 25 } 26 27 public void setPasswd(String passwd) { 28 this.passwd = passwd; 29 } 30 31 public String getSex() { 32 return sex; 33 } 34 35 public void setSex(String sex) { 36 this.sex = sex; 37 } 38 39 public String getAge() { 40 return age; 41 } 42 43 public void setAge(String age) { 44 this.age = age; 45 } 46 47 @Override 48 public String toString() { 49 return "User{" + 50 "name='" + name + '\'' + 51 ", passwd='" + passwd + '\'' + 52 ", sex='" + sex + '\'' + 53 ", age='" + age + '\'' + 54 '}'; 55 } 56 }
NetworkUtil.java用於網絡情況的判斷，實現代碼以下：
1 package com.jy.jerseyclient.utils; 2 3 import android.content.Context; 4 import android.net.ConnectivityManager; 5 6 /** 7 * 網絡相關工具類 8 * @author xy 9 * 10 */ 11 public class NetworkUtil { 12 /** 13 * 判斷是否有可用網絡 14 * @param context 15 * @return 16 */ 17 public static boolean isNetWorkOpened(Context context) { 18 ConnectivityManager connManager = (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE); 19 if (connManager.getActiveNetworkInfo() != null) { 20 return connManager.getActiveNetworkInfo().isAvailable(); 21 } 22 return false; 23 } 24 }
好了，剩下的就是登錄界面和主界面了，Activity的佈局和邏輯都很是簡單，我直接把代碼貼上。
LoginActivty：
1 package com.jy.jerseyclient; 2 3 import android.content.Intent; 4 import android.os.AsyncTask; 5 import android.os.Bundle; 6 import android.support.v7.app.AppCompatActivity; 7 import android.text.TextUtils; 8 import android.util.Log; 9 import android.view.View; 10 import android.widget.Button; 11 import android.widget.EditText; 12 import android.widget.Toast; 13 14 import com.jy.jerseyclient.entity.Response; 15 import com.jy.jerseyclient.entity.User; 16 import com.jy.jerseyclient.service.WebService; 17 import com.jy.jerseyclient.utils.JsonUtil; 18 import com.jy.jerseyclient.utils.NetworkUtil; 19 20 public class LoginActivity extends AppCompatActivity { 21 private final static String TAG = "LoginActivity"; 22 private EditText edt_username; 23 private EditText edt_password; 24 private Button btn_login; 25 26 @Override 27 protected void onCreate(Bundle savedInstanceState) { 28 super.onCreate(savedInstanceState); 29 setContentView(R.layout.activity_login); 30 31 initView(); 32 initEvent(); 33 } 34 35 private void initView() { 36 edt_username = (EditText) findViewById(R.id.edt_username); 37 edt_password = (EditText) findViewById(R.id.edt_password); 38 btn_login = (Button) findViewById(R.id.btn_login); 39 } 40 41 private void initEvent() { 42 btn_login.setOnClickListener(new View.OnClickListener() { 43 @Override 44 public void onClick(View v) { 45 final String username = edt_username.getText().toString(); 46 if (TextUtils.isEmpty(username)) { 47 Toast.makeText(LoginActivity.this, 48 "user name must not be empty", Toast.LENGTH_SHORT).show(); 49 return; 50 } 51 final String password = edt_password.getText().toString(); 52 if (TextUtils.isEmpty(password)) { 53 Toast.makeText(LoginActivity.this, 54 "password must not be empty", Toast.LENGTH_SHORT).show(); 55 return; 56 } 57 if (NetworkUtil.isNetWorkOpened(LoginActivity.this)) { 58 new AsyncTask<String, Integer, Response>() { 59 @Override 60 protected Response doInBackground(String... params) { 61 Response response = WebService.login(username, password); 62 return response; 63 } 64 65 @Override 66 protected void onPostExecute(Response response) { 67 if (response == null) { 68 Toast.makeText(LoginActivity.this, "login failed,response is null", 69 Toast.LENGTH_SHORT).show(); 70 } else if (200 == response.getStatus()) { 71 Log.e(TAG, "user======" + response.toString()); 72 Object obj = response.getResponse(); 73 if (obj == null) { 74 Toast.makeText(LoginActivity.this, 75 "login failed,the response field is null", 76 Toast.LENGTH_SHORT).show(); 77 } else { 78 User user = JsonUtil.getEntity(obj.toString(), User.class); 79 if (user == null) { 80 Toast.makeText(LoginActivity.this, "login failed,illegal json", 81 Toast.LENGTH_SHORT).show(); 82 } else { 83 Toast.makeText(LoginActivity.this, "login succeed", 84 Toast.LENGTH_SHORT).show(); 85 Intent intent = new Intent(LoginActivity.this, MainActivity.class); 86 intent.putExtra("user", user); 87 startActivity(intent); 88 finish(); 89 } 90 } 91 } else { 92 Toast.makeText(LoginActivity.this, 93 "login failed，" + response.getMessage(), 94 Toast.LENGTH_SHORT).show(); 95 } 96 super.onPostExecute(response); 97 } 98 }.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR); 99 } else { 100 Toast.makeText(LoginActivity.this, 101 "network is not available", Toast.LENGTH_SHORT).show(); 102 } 103 } 104 }); 105 } 106 }
LoginActivty的佈局文件：
1 <?xml version="1.0" encoding="utf-8"?> 2 <LinearLayout 3 xmlns:android="http://schemas.android.com/apk/res/android" 4 xmlns:tools="http://schemas.android.com/tools" 5 android:layout_width="match_parent" 6 android:layout_height="match_parent" 7 tools:context=".MainActivity" 8 android:orientation="vertical" 9 android:background="#FFFFFF" 10 android:gravity="center" > 11 12 <RelativeLayout 13 android:layout_width="match_parent" 14 android:layout_height="wrap_content" > 15 16 <TextView 17 android:id="@+id/tv_username" 18 android:layout_width="wrap_content" 19 android:layout_height="wrap_content" 20 android:text="用戶名" 21 android:textSize="18sp" 22 android:layout_alignParentLeft="true" /> 23 24 <EditText 25 android:id="@+id/edt_username" 26 android:layout_width="match_parent" 27 android:layout_height="wrap_content" 28 android:layout_alignParentRight="true" 29 android:layout_toRightOf="@id/tv_username" 30 android:textSize="18sp" /> 31 32 </RelativeLayout> 33 34 <RelativeLayout 35 android:layout_width="match_parent" 36 android:layout_height="wrap_content" 37 android:layout_marginTop="20dp" > 38 39 <TextView 40 android:id="@+id/tv_password" 41 android:layout_width="wrap_content" 42 android:layout_height="wrap_content" 43 android:text="密 碼" 44 android:textSize="18sp" 45 android:layout_alignParentLeft="true" /> 46 47 <EditText 48 android:id="@+id/edt_password" 49 android:layout_width="match_parent" 50 android:layout_height="wrap_content" 51 android:layout_alignParentRight="true" 52 android:layout_toRightOf="@id/tv_password" 53 android:inputType="textPassword" 54 android:textSize="18sp" /> 55 </RelativeLayout> 56 57 <Button 58 android:id="@+id/btn_login" 59 android:layout_width="match_parent" 60 android:layout_height="wrap_content" 61 android:text="登陸" 62 android:textSize="18sp" 63 android:gravity="center" 64 android:layout_marginTop="50dp" /> 65 </LinearLayout>
MainActivity:
1 package com.jy.jerseyclient; 2 3 import android.content.Intent; 4 import android.os.AsyncTask; 5 import android.os.Bundle; 6 import android.support.v7.app.AppCompatActivity; 7 import android.util.Log; 8 import android.view.View; 9 import android.widget.Button; 10 import android.widget.TextView; 11 import android.widget.Toast; 12 13 import com.jy.jerseyclient.entity.Response; 14 import com.jy.jerseyclient.entity.User; 15 import com.jy.jerseyclient.service.WebService; 16 import com.jy.jerseyclient.utils.JsonUtil; 17 import com.jy.jerseyclient.utils.NetworkUtil; 18 19 import java.util.ArrayList; 20 21 public class MainActivity extends AppCompatActivity { 22 private final static String TAG = "MainActivity"; 23 private TextView tv_welcome; 24 private Button btn_show_all_users; 25 26 @Override 27 protected void onCreate(Bundle savedInstanceState) { 28 super.onCreate(savedInstanceState); 29 setContentView(R.layout.activity_main); 30 31 initView(); 32 initEvent(); 33 initData(); 34 } 35 36 private void initView() { 37 tv_welcome = (TextView) findViewById(R.id.tv_welcome); 38 btn_show_all_users = (Button) findViewById(R.id.btn_show_all_users); 39 } 40 41 private void initEvent() { 42 btn_show_all_users.setOnClickListener(new View.OnClickListener() { 43 @Override 44 public void onClick(View v) { 45 if (NetworkUtil.isNetWorkOpened(MainActivity.this)) { 46 new AsyncTask<String, Integer, Response>() { 47 @Override 48 protected Response doInBackground(String... params) { 49 Response response = WebService.getAllUsers(); 50 return response; 51 } 52 53 @Override 54 protected void onPostExecute(Response response) { 55 if (response == null) { 56 Toast.makeText(MainActivity.this, 57 "request failed,response is null", 58 Toast.LENGTH_SHORT).show(); 59 } else if (200 == response.getStatus()) { 60 Log.e(TAG, "user======" + response.toString()); 61 Object obj = response.getResponse(); 62 if (obj == null) { 63 Toast.makeText(MainActivity.this, 64 "request failed,the response field is null", 65 Toast.LENGTH_SHORT).show(); 66 } else { 67 ArrayList<User> users = (ArrayList<User>) 68 JsonUtil.getEntityList(obj.toString(), User.class); 69 if (users == null) { 70 Toast.makeText(MainActivity.this, 71 "request failed,illegal json", 72 Toast.LENGTH_SHORT).show(); 73 } else { 74 StringBuilder allUserInfo = new StringBuilder(); 75 for (User u : users) { 76 allUserInfo.append(u.getName() + ":" + u.getSex() + "," 77 + u.getAge() + "\n"); 78 } 79 tv_welcome.setText(allUserInfo); 80 } 81 } 82 } else { 83 Toast.makeText(MainActivity.this, 84 "request failed," + response.getMessage(), 85 Toast.LENGTH_SHORT).show(); 86 } 87 super.onPostExecute(response); 88 } 89 }.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR); 90 } else { 91 Toast.makeText(MainActivity.this, 92 "network is not available", Toast.LENGTH_SHORT).show(); 93 } 94 } 95 }); 96 } 97 98 private void initData() { 99 Intent intent = getIntent(); 100 if (intent != null) { 101 User user = (User) intent.getExtras().getSerializable("user"); 102 if (user != null) { 103 tv_welcome.setText("Welcome," + user.getName()); 104 } 105 } 106 } 107 }
MainActivty的佈局文件：
1 <?xml version="1.0" encoding="utf-8"?> 2 <RelativeLayout 3 xmlns:android="http://schemas.android.com/apk/res/android" 4 xmlns:tools="http://schemas.android.com/tools" 5 android:layout_width="match_parent" 6 android:layout_height="match_parent" 7 android:fitsSystemWindows="true" 8 tools:context=".MainActivity"> 9 10 <TextView 11 android:id="@+id/tv_welcome" 12 android:layout_width="match_parent" 13 android:layout_height="wrap_content" 14 android:text="歡迎您" 15 android:textSize="18sp" /> 16 17 <Button 18 android:id="@+id/btn_show_all_users" 19 android:layout_width="match_parent" 20 android:layout_height="wrap_content" 21 android:text="顯示全部用戶" 22 android:textSize="18sp" 23 android:layout_below="@id/tv_welcome" 24 android:layout_marginTop="20dp" /> 25 26 </RelativeLayout>
最後，別忘了配置清單文件，以下所示：
1 <?xml version="1.0" encoding="utf-8"?> 2 <manifest xmlns:android="http://schemas.android.com/apk/res/android" 3 package="com.jy.jerseyclient" > 4 5 <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> 6 <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" /> 7 <uses-permission android:name="android.permission.INTERNET" /> 8 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> 9 10 <application 11 android:allowBackup="true" 12 android:icon="@mipmap/ic_launcher" 13 android:label="@string/app_name" 14 android:supportsRtl="true" 15 android:theme="@style/AppTheme" > 16 <activity 17 android:name=".LoginActivity" 18 android:label="@string/app_name" 19 android:theme="@style/AppTheme.NoActionBar" > 20 <intent-filter> 21 <action android:name="android.intent.action.MAIN" /> 22 23 <category android:name="android.intent.category.LAUNCHER" /> 24 </intent-filter> 25 </activity> 26 27 <activity android:name=".MainActivity" /> 28 </application> 29 30 </manifest>
好了，到此客戶端和服務端均已大功告成，整個項目其實就是用最簡單的模型來講明怎樣利用Jersey這個框架來爲咱們的移動端搭建後臺接口，其中，不免有諸多紕漏之處，請你們多多批評指正，謝謝！
最後，附上項目源碼的下載連接：
客戶端：①http://download.csdn.net/detail/owoxiangxin12/9492575 ②https://github.com/monkey1992/JerseyClient
服務端：①http://download.csdn.net/detail/owoxiangxin12/9492571 ②https://github.com/monkey1992/JerseyServer
相關文章
- 1. Jersey RESTful開發
- 2. jersey實現web service接口+客戶端調用
- 3. REST Service 開發 - 客戶端
- 4. Jersey framework開發RESTFUL應用
- 5. 利用Tomcat發佈基於Maven所構建的Jersey RESTful Web Service
- 6. C++上傳文件到Restful Web Service服務端——客戶端篇
- 7. Jersey RESTful Web服務
- 8. 【web service】使用cxf對客戶端進行開發工做
- 9. 使用Eclipse的Axis1.4插件開發Web Service及客戶端
- 10. Java Android客戶端開發
- 更多相關文章...
- • XSLT - 在客戶端 - XSLT 教程
- • Web Service 實例 - Web Services 教程
- • PHP開發工具
- • 使用阿里雲OSS+CDN部署前端頁面與加速靜態資源
相關標籤/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
最新文章
歡迎關注本站公眾號,獲取更多信息
相關文章
- 1. Jersey RESTful開發
- 2. jersey實現web service接口+客戶端調用
- 3. REST Service 開發 - 客戶端
- 4. Jersey framework開發RESTFUL應用
- 5. 利用Tomcat發佈基於Maven所構建的Jersey RESTful Web Service
- 6. C++上傳文件到Restful Web Service服務端——客戶端篇
- 7. Jersey RESTful Web服務
- 8. 【web service】使用cxf對客戶端進行開發工做
- 9. 使用Eclipse的Axis1.4插件開發Web Service及客戶端
- 10. Java Android客戶端開發