[置顶] 直接在服务器与客户端之间传输对象

客户端与服务器之间传输对象

一、前言

    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 中都涉及到此问题。