直接在伺服器與客戶端之間傳輸物件
客戶端與伺服器之間傳輸物件
一、前言
1.網路程式設計的使用十分廣泛,且相當重要,一個有用的Android 程式一定涉及資料物件的傳輸處理。
2.本文將以例項分析一個使用者物件是怎樣在網路中傳輸的。
具體實現之前,大致分析一下其過程原理:
原理如下:
User物件 --> json 資料 --> 手機客戶端 --> 伺服器 --> json 資料 --> User物件
3.所用平臺:
android studio ,MyEclipse 也可用 eclipse
二、原理分析詳解
其實就是在 android 客戶端例項化一個使用者 User 物件,或者說將一個已有的使用者物件 user 封裝成 json 資料;然後通過 http 協議從手機客戶端傳送到伺服器端;伺服器接收到請求,並處理json 資料,解析 json 資料;其實很簡單;然後將解析後的資料給一個例項化的 使用者User u = new User(),通過 u.setter() 方法將資料設定為物件的資料,這樣物件在客戶端與伺服器之間的傳輸就成功了。
以下檔名、類名、變數或者包名等名字的建立可自定義
三、Android 客戶端程式碼實現
接下來上程式碼實現該過程:
首先android 客戶端:
1.工程結構:
2.檔案程式碼
(1)佈局檔案 activity_main.xml
也不寫多複雜的介面了,就簡單的新增一個Button 按鈕控制元件,點選按鈕觸發傳送物件事件即可,
所以 layout 下 activity_main.xml 檔案程式碼很簡單:
程式碼如下:
<?xml version="1.0" encoding="utf-8"?> <RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" android:layout_width="match_parent" android:layout_height="match_parent" android:paddingBottom="@dimen/activity_vertical_margin" android:paddingLeft="@dimen/activity_horizontal_margin" android:paddingRight="@dimen/activity_horizontal_margin" android:paddingTop="@dimen/activity_vertical_margin" android:background="@drawable/back" tools:context="rfeng.pers.winsock.MainActivity"> <Button android:id="@+id/button" android:layout_width="80dp" android:layout_height="30dp" android:background="#fff" android:gravity="center" android:text="send" android:textSize="15dp" /> </RelativeLayout>
(2)使用者物件類 User.java
在新建model 包下建一個類 User :該類得實現 Serializable 介面,否則不能在網路中傳輸
package rfeng.pers.model; import java.io.Serializable; /** * Created by Administrator on 2016/8/14 0014. */ public class User implements Serializable { private String username; private String gender; private int age; public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getGender() { return gender; } public void setGender(String gender) { this.gender = gender; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } /** * 寫一個構造方法,能直接將所有資訊初始化 */ public User(String username, String gender, int age){ this.username = username; this.gender = gender; this.age = age; } public User(){ super(); } }
(3)物件資料相關操作處理類TransObjectToWeb.java
在新建包 web 下建一個類 TransObjectToWeb:實現物件的封裝,與http 協議請求的傳送及與伺服器的互動
package rfeng.pers.web;
import android.util.Log;
import org.json.JSONArray;
import org.json.JSONObject;
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import rfeng.pers.model.User;
/**
* Created by Administrator on 2016/8/14 0014.
*/
public class TransObjectToWeb {
/**
* 建立方法:將物件傳輸到 web 端
* @param user
*/
private Boolean flag = false;
public boolean sendToWeb(User user){
try {
// (1)伺服器的訪問路徑
Log.i("TAG","建立連線");
URL url = new URL("http://192.168.0.28:8080/WinSockWeb/WinSockForAndroid");
HttpURLConnection http = (HttpURLConnection) url.openConnection(); //例項化連線物件
http.setDoInput(true); //可讀可寫
http.setDoOutput(true);
http.setUseCaches(false); //不允許使用快取
http.setRequestMethod("POST"); //設定傳輸方式為 post
http.connect(); //建立連線
Log.i("TAG","建立連線成功");
// (2)資料寫入流傳送至伺服器
OutputStream os = http.getOutputStream();
OutputStreamWriter osw = new OutputStreamWriter(os);
BufferedWriter bw = new BufferedWriter(osw);
Log.i("TAG","建立json 物件");
JSONArray jsonArray = new JSONArray(); //建立 json 物件
JSONObject jsonObject = new JSONObject();
jsonObject.put("username",user.getUsername()); //寫入物件資料
jsonObject.put("gender",user.getGender());
jsonObject.put("age",user.getAge());
jsonArray.put(jsonObject);
bw.write(jsonArray.toString());
bw.flush();
// (3)資料讀取流接收資料
InputStream is = http.getInputStream();
InputStreamReader isr = new InputStreamReader(is);
BufferedReader br = new BufferedReader(isr);
String result = br.readLine(); //獲取web 端返回的資料
if (result.equals("succeed")) { //如果返回資料為 succeed 處理成功,否則失敗
flag = true;
}
// (4)關閉相關流
if (os != null) os.close();
if (osw != null) osw.close();
if (is != null) is.close();
if (isr != null) isr.close();
if (br != null) br.close();
if (bw != null) bw.close();
} catch (Exception e){e.printStackTrace();}
return flag;
}
}
(4)MainActivity.java
在MainActivity 中寫程式碼相關操作:實現點選事件的觸發,呼叫 TransObjectToWeb 中傳輸物件的方法,實現物件傳輸
package rfeng.pers.winsock;
import android.os.Looper;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.Toast;
import rfeng.pers.model.User;
import rfeng.pers.web.TransObjectToWeb;
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Button btn = (Button)findViewById(R.id.button);
btn.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
new Thread(new Runnable() {
@Override
public void run() {
User user = new User("張小凡","男",19); //例項化用於測試的傳輸物件
TransObjectToWeb toWeb = new TransObjectToWeb();//例項化該類物件,呼叫其傳輸物件方法
boolean flag = toWeb.sendToWeb(user);
if (flag) {
Looper.prepare();
Toast.makeText(MainActivity.this, "物件傳輸成功!", Toast.LENGTH_SHORT).show();
Looper.loop();
} else {
Looper.prepare();
Toast.makeText(MainActivity.this, "網路繁忙!", Toast.LENGTH_SHORT).show();
Looper.loop();
}
}
}).start();
}
});
}
}
(5)配置檔案
AndroidManifest.xml 配置檔案:
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="rfeng.pers.winsock">
<!--
網路許可權:部分不新增該許可權也可實現網路連線,但建議新增該許可權
-->
<uses-permission android:name="android.permission.INTERNET" />
<application
android:allowBackup="true"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:supportsRtl="true"
android:theme="@style/AppTheme">
<activity android:name=".MainActivity">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
</application>
</manifest>
四、伺服器端
然後是伺服器端:
新建web project 工程命名為:WinSockWeb;
匯入json 相關包;
(1)使用者物件類User.java
在新建包model 下:建立類 User ,與android 客戶端對應,因為傳輸的物件有相同的屬性,方法;
package cn.hpu.edu.model;
public class User {
private String username;
private String gender;
private int age;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getGender() {
return gender;
}
public void setGender(String gender) {
this.gender = gender;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}
(2)servlet 檔案
在新建包android 下新建 servlet 檔案命名為:WinSockForAndroid
實現接收客戶端的請求,並做出相關處理後,返回結果給客戶端:
package cn.hpu.edu.android;
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.json.JSONArray;
import org.json.JSONObject;
import cn.hpu.edu.model.User;
public class WinSockForAndroid extends HttpServlet {
private static final long serialVersionUID = 1L;
public void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
this.doPost(request, response);
}
public void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
request.setCharacterEncoding("utf-8"); //設定編碼方式
response.setCharacterEncoding("utf-8");
System.out.println("接收到請求");
User user = null; //初始化接收的傳輸物件為空
//(1) 獲取android 請求,對傳輸物件的資料進行處理
InputStream is = request.getInputStream();
InputStreamReader isr = new InputStreamReader(is,"utf-8");
BufferedReader br = new BufferedReader(isr);
String userjson = br.readLine();
System.out.println("userjson:"+userjson.toString()); //輸出 json 格式資料
try {
JSONArray userarr = new JSONArray(userjson);
JSONObject userobj = userarr.getJSONObject(0);
user = new User(); //例項化 user 物件,否則報空指標異常
user.setUsername(userobj.getString("username"));
user.setGender(userobj.getString("gender"));
user.setAge(userobj.getInt("age"));
System.out.println("該傳輸物件:\n"
+"姓名: "+user.getUsername()
+"\n性別: "+user.getGender()
+"\n年齡: "+user.getAge());
// (2)返回結果,成功或失敗
OutputStream os = response.getOutputStream();
OutputStreamWriter osw = new OutputStreamWriter(os,"utf-8");
BufferedWriter bw = new BufferedWriter(osw);
if (user != null)
bw.write("succeed");
else
bw.write("error");
bw.flush();
if (os != null) os.close();
if (osw != null) osw.close();
if (is != null) is.close();
if (isr != null) isr.close();
if (br != null) br.close();
if (bw != null) bw.close();
} catch (Exception e){e.printStackTrace();}
}
}
(5)配置檔案
web.xml 配置:
在 Myeclipse平臺下自動生成,在 eclipse一般自己寫
<?xml version="1.0" encoding="UTF-8"?>
<web-app version="3.0"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
<servlet>
<description>This is the description of my J2EE component</description>
<display-name>This is the display name of my J2EE component</display-name>
<servlet-name>WinSockForAndroid</servlet-name>
<servlet-class>cn.hpu.edu.android.WinSockForAndroid</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>WinSockForAndroid</servlet-name>
<url-pattern>/WinSockForAndroid</url-pattern>
</servlet-mapping>
</web-app>
五、實現效果
讓我們看一下執行結果:
例項化物件
然後呼叫方法傳輸該使用者物件
手機客戶端點選 send 傳送按鈕,出發事件,呼叫相關方法封裝物件傳送至伺服器,接收到請求後解析資料,對資料進行處理,後返回相關結果。
客戶端執行介面,沒多加修飾,僅一個Button 控制元件
點選按鈕,傳送物件,提示成功
成功情況下:伺服器端控制檯輸出如下:
android studio 控制檯也列印日誌:http 協議請求伺服器成功
六、總結
注意:
1.此工程可用,需注意,主要是通過 json 資料的封裝與解析來處理物件在網路傳輸中的資料型別,須匯入 json 相關包,才可;
2.配置檔案也需注意;
3.同時 android 端需注意使用者 User 物件必須實現介面 Serializable ;
4.其中重點json 資料的封裝與解析其實也很簡單,在 TransObjectToWeb 和 WinSockForAndroid 中都涉及到此問題。