1. 如何通过Retrofit提交json格式数据
本文将介绍如何通过retrofit库post一串json格式的数据。首先post的json数据格式如下：
{
"Id": "string",
"DeviceId": "string",
"Name": "string",
"SumDistance": 0,
"RouteNo": "string",
"SumPoints": 0,
"SetupTime": "2016-06-10T13:11:00.766Z",
"UsedTime": 0,
"Points": [
{
"Id": "string",
"RouteNo": "string",
"Name": "string",
"Longitude": "string",
"Latitude": "string",
"Height": 0,
"Distance": 0,
"Yaw": 0,
"Pitch": 0,
"Speed": 0,
"Usedtime": 0
}
]
}
通过安装Android studio gsonformat插件，根据上面的json格式自动生成一个Bean类，本文命名为FlyRouteBean，
[java] view plain
package com.example.administrator.retrofitex;
import java.util.List;
import android.os.Parcel;
import android.os.Parcelable;
/**
* Created by Administrator on 2016/6/10.
*/
public class FlyRouteBean{
/**
* Id : string
* DeviceId : string
* Name : string
* SumDistance : 0
* RouteNo : string
* SumPoints : 0
* SetupTime : 2016-05-23T06:20:50.254Z
* UsedTime : 0
* Points : [{"Id":"string","RouteNo":"string","Name":"string","Longitude":"string","Latitude":"string","Height":0,"Distance":0,"Yaw":0,"Pitch":0,"Speed":0,"Usedtime":0}]
*/
public String Id;
public String DeviceId;
public String Name;
public double SumDistance;
public String RouteNo;
public int SumPoints;
public String SetupTime;
public double UsedTime;
/**
* Id : string
* RouteNo : string
* Name : string
* Longitude : string
* Latitude : string
* Height : 0
* Distance : 0
* Yaw : 0
* Pitch : 0
* Speed : 0
* Usedtime : 0
*/
public List<PointsBean> Points;
public String getId() {
return Id;
}
public void setId(String Id) {
this.Id = Id;
}
public String getDeviceId() {
return DeviceId;
}
public void setDeviceId(String DeviceId) {
this.DeviceId = DeviceId;
}
public String getName() {
return Name;
}
public void setName(String Name) {
this.Name = Name;
}
public double getSumDistance() {
return SumDistance;
}
public void setSumDistance(double SumDistance) {
this.SumDistance = SumDistance;
}
public String getRouteNo() {
return RouteNo;
}
public void setRouteNo(String RouteNo) {
this.RouteNo = RouteNo;
}
public int getSumPoints() {
return SumPoints;
}
public void setSumPoints(int SumPoints) {
this.SumPoints = SumPoints;
}
public String getSetupTime() {
return SetupTime;
}
public void setSetupTime(String SetupTime) {
this.SetupTime = SetupTime;
}
public double getUsedTime() {
return UsedTime;
}
public void setUsedTime(double UsedTime) {
this.UsedTime = UsedTime;
}
public List<PointsBean> getPoints() {
return Points;
}
public void setPoints(List<PointsBean> Points) {
this.Points = Points;
}
public static class PointsBean implements Parcelable {
public String Id;
public String RouteNo;
public String Name;
public String Longitude;
public String Latitude;
public double Height;
public double Distance;
public double Yaw;
public double Pitch;
public double Speed;
public double Usedtime;
public String getId() {
return Id;
}
public void setId(String Id) {
this.Id = Id;
}
public String getRouteNo() {
return RouteNo;
}
public void setRouteNo(String RouteNo) {
this.RouteNo = RouteNo;
}
public String getName() {
return Name;
}
public void setName(String Name) {
this.Name = Name;
}
public String getLongitude() {
return Longitude;
}
public void setLongitude(String Longitude) {
this.Longitude = Longitude;
}
public String getLatitude() {
return Latitude;
}
public void setLatitude(String Latitude) {
this.Latitude = Latitude;
}
public double getHeight() {
return Height;
}
public void setHeight(double Height) {
this.Height = Height;
}
public double getDistance() {
return Distance;
}
public void setDistance(double Distance) {
this.Distance = Distance;
}
public double getYaw() {
return Yaw;
}
public void setYaw(double Yaw) {
this.Yaw = Yaw;
}
public double getPitch() {
return Pitch;
}
public void setPitch(double Pitch) {
this.Pitch = Pitch;
}
public double getSpeed() {
return Speed;
}
public void setSpeed(double Speed) {
this.Speed = Speed;
}
public double getUsedtime() {
return Usedtime;
}
public void setUsedtime(double Usedtime) {
this.Usedtime = Usedtime;
}
@Override
public String toString() {
return "PointsBean{" +
"Id='" + Id + '\'' +
", RouteNo='" + RouteNo + '\'' +
", Name='" + Name + '\'' +
", Longitude='" + Longitude + '\'' +
", Latitude='" + Latitude + '\'' +
", Height=" + Height +
", Distance=" + Distance +
", Yaw=" + Yaw +
", Pitch=" + Pitch +
", Speed=" + Speed +
", Usedtime=" + Usedtime +
'}';
}
@Override
public void writeToParcel(Parcel dest, int flags) {
// TODO Auto-generated method stub
dest.writeString(Id);
dest.writeString(RouteNo);
dest.writeString(Name);
dest.writeString(Longitude);
dest.writeString(Latitude);
dest.writeDouble(Height);
dest.writeDouble(Distance);
dest.writeDouble(Yaw);
dest.writeDouble(Pitch);
dest.writeDouble(Speed);
dest.writeDouble(Usedtime);
}
public static final Creator<PointsBean> CREATOR=new Creator<PointsBean>() {
@Override
public PointsBean createFromParcel(Parcel source) {
// TODO Auto-generated method stub
PointsBean pointsBean=new PointsBean();
pointsBean.setId(source.readString());
pointsBean.setRouteNo(source.readString());
pointsBean.setName(source.readString());
pointsBean.setLongitude(source.readString());
pointsBean.setLatitude(source.readString());
pointsBean.setHeight(source.readInt());
pointsBean.setDistance(source.readInt());
pointsBean.setYaw(source.readInt());
pointsBean.setPitch(source.readInt());
pointsBean.setSpeed(source.readInt());
pointsBean.setUsedtime(source.readInt());
return pointsBean;
}
@Override
public PointsBean[] newArray(int size) {
// TODO Auto-generated method stub
return new PointsBean[size];
}
};
@Override
public int describeContents() {
// TODO Auto-generated method stub
return 0;
}
}
@Override
public String toString() {
return "FlyRouteBean{" +
"Id='" + Id + '\'' +
", DeviceId='" + DeviceId + '\'' +
", Name='" + Name + '\'' +
", SumDistance=" + SumDistance +
", RouteNo='" + RouteNo + '\'' +
", SumPoints=" + SumPoints +
", SetupTime='" + SetupTime + '\'' +
", UsedTime=" + UsedTime +
", Points=" + Points +
'}';
}
}
然后就来建立接口了，其内容如下：
[java] view plain
public interface PostRoute {
@Headers({"Content-Type: application/json","Accept: application/json"})//需要添加头
@POST("api/FlyRoute/Add")
Call<FlyRouteBean> postFlyRoute(@Body RequestBody route);//传入的参数为RequestBody
}
接下来就是提交数据的了：
[java] view plain
FlyRouteBean flyRouteBean=new FlyRouteBean();
flyRouteBean=initdata(flyRouteBean);//根据Bean类初始化一个需要提交的数据类
Gson gson=new Gson();
String route= gson.toJson(flyRouteBean);//通过Gson将Bean转化为Json字符串形式
[java] view plain
Retrofit retrofit=new Retrofit.Builder()
.baseUrl(URL)
.addConverterFactory( GsonConverterFactory.create())
.build();
PostRoute postRoute=retrofit.create(PostRoute.class);
RequestBody body=RequestBody.create(okhttp3.MediaType.parse("application/json; charset=utf-8"),route);
Call<FlyRouteBean> call=postRoute.postFlyRoute(body);
call.enqueue(new Callback<FlyRouteBean>() {
@Override
public void onResponse(Call<FlyRouteBean> call, Response<FlyRouteBean> response) {
Log.e("sssss","-----------------------"+response.body().getDeviceId());//这里是用于测试，服务器返回的数据就是提交的数据。
}
@Override
public void onFailure(Call<FlyRouteBean> call, Throwable t) {
Log.e("sssss",t.getMessage());
}
});
需要添加的依赖：
compile 'com.squareup.retrofit2:retrofit:2.0.2'
compile 'com.squareup.retrofit2:converter-gson:2.0.0-beta3'
2. refit默认windows启动
refit默认windows启动()1.简介Refit是一个受到Square的Retrofit库（Java）启发的自动类型安全REST库。通过HttpClient网络请求(POST，GET,PUT，DELETE等封装)把REST API返回的数据转化为POCO(Plain Ordinary C# Object,简单C#对象) to JSON。我们的应用程序通过Refit请求网络，实际上是使用Refit接口层封装请求参数、Header、Url等信息，之后由HttpClient完成后续的请求操作，在服务端返回数据之后，HttpClient将原始的结果交给Refit，后者根据用户的需求对结果进行解析的过程。安装组件命令行：
Install-Package refit代码例子：
[Headers("User-Agent: Refit Integration Tests")]//这里因为目标源是GitHubApi，所以一定要加入这个静态请求标头信息，让其这是一个测试请求，不然会返回数据异常。public interface IGitHubApi{ [Get("/users/{user}")] Task GetUser(string user);}public class GitHubApi{ public async Task GetUser() { var gitHubApi = RestService.For("https://api.github.com"); var octocat = await gitHubApi.GetUser("octocat"); return octocat; }}public class User{ public string login { get; set; } public int? id { get; set; } public string url { get; set; }}[HttpGet]public async Task<ActionResult<IEnumerable>> Get(){ var result = await new GitHubApi().GetUser(); return new string[] { result.id.Value.ToString(), result.login };}注：接口中Headers、Get这些属性叫做Refit的特性。定义上面的一个IGitHubApi的REST API接口，该接口定义了一个函数GetUser，该函数会通过HTTP GET请求去访问服务器的/users/{user}路径把返回的结果封装为User POCO对象并返回。其中URL路径中的{user}的值为GetUser函数中的参数user的取值，这里赋值为octocat。然后通过RestService类来生成一个IGitHubApi接口的实现并供HttpClient调用。
2.API属性
每个方法必须具有提供请求URL和HTTP属性。HTTP属性有六个内置注释：Get, Post, Put, Delete, Patch and Head，例：
[Get("/users/list")]您还可以在请求URL中指定查询参数：
[Get("/users/list?sort=desc")]还可以使用相对URL上的替换块和参数来动态请求资源。替换块是由{and，即&}包围的字母数字字符串。如果参数名称与URL路径中的名称不匹配，请使用AliasAs属性，例：
[Get("/group/{id}/users")]Task<List> GroupList([AliasAs("id")] int groupId);请求URL还可以将替换块绑定到自定义对象，例：
[Get("/group/{request.groupId}/users/{request.userId}")]Task<List> GroupList(UserGroupRequest request);class UserGroupRequest{ int groupId { get;set; } int userId { get;set; }}未指定为URL替换的参数将自动用作查询参数。这与Retrofit不同，在Retrofit中，必须明确指定所有参数，例：
[Get("/group/{id}/users")]Task<List> GroupList([AliasAs("id")] int groupId, [AliasAs("sort")] string sortOrder);GroupList(4, "desc");输出结果："/group/4/users?sort=desc"
3.动态查询字符串参数(Dynamic Querystring Parameters)
方法还可以传递自定义对象，把对象属性追加到查询字符串参数当中，例如：
public class MyQueryParams{ [AliasAs("order")] public string SortOrder { get; set; } public int Limit { get; set; }}[Get("/group/{id}/users")]Task<List> GroupList([AliasAs("id")] int groupId, MyQueryParams params);[Get("/group/{id}/users")]Task<List> GroupListWithAttribute([AliasAs("id")] int groupId, [Query(".","search")]MyQueryParams params);params.SortOrder = "desc";params.Limit = 10;GroupList(4, params)输出结果："/group/4/users?order=desc&Limit=10"
GroupListWithAttribute(4, params)输出结果："/group/4/users?search.order=desc&search.Limit=10"您还可以使用[Query]指定querystring参数，并将其在非GET请求中扁平化，类似于：
[Post("/statuses/update.json")]Task PostTweet([Query]TweetParams params);5.集合作为查询字符串参数(Collections as Querystring Parameters)方法除了支持传递自定义对象查询，还支持集合查询的，例：
[Get("/users/list")]Task Search([Query(CollectionFormat.Multi)]int[] ages);Search(new [] {10, 20, 30})输出结果："/users/list?ages=10&ages=20&ages=30"
[Get("/users/list")]Task Search([Query(CollectionFormat.Csv)]int[] ages);Search(new [] {10, 20, 30})输出结果："/users/list?ages=10%2C20%2C30"
6.转义符查询字符串参数(Unescape Querystring Parameters)
使用QueryUriFormat属性指定查询参数是否应转义网址，例：
[Get("/query")][QueryUriFormat(UriFormat.Unescaped)]Task Query(string q);Query("Select+Id,Name+From+Account")输出结果："/query?q=Select+Id,Name+From+Account"
7.Body内容
通过使用Body属性，可以把自定义对象参数追加到HTTP请求Body当中。
[Post("/users/new")]Task CreateUser([Body] User user)根据参数的类型，提供Body数据有四种可能性：●如果类型为Stream，则内容将通过StreamContent流形式传输。●如果类型为string，则字符串将直接用作内容，除非[Body(BodySerializationMethod.Json)]设置了字符串，否则将其作为StringContent。●如果参数具有属性[Body(BodySerializationMethod.UrlEncoded)]，则内容将被URL编码。●对于所有其他类型，将使用RefitSettings中指定的内容序列化程序将对象序列化（默认为JSON）。●缓冲和Content-Length头默认情况下，Refit重新调整流式传输正文内容而不缓冲它。例如，这意味着您可以从磁盘流式传输文件，而不会产生将整个文件加载到内存中的开销。这样做的缺点是没有在请求上设置内容长度头（Content-Length）。如果您的API需要您随请求发送一个内容长度头，您可以通过将[Body]属性的缓冲参数设置为true来禁用此流行为：
Task CreateUser([Body(buffered: true)] User user);7.1.JSON内容使用Json.NET对JSON请求和响应进行序列化/反序列化。默认情况下，Refit将使用可以通过设置Newtonsoft.Json.JsonConvert.DefaultSettings进行配置的序列化器设置：
JsonConvert.DefaultSettings = () => new 电脑 JsonSerializerSettings() { ContractResolver = new (), Converters = {new StringEnumConverter()} };//Serialized as: {"day":"Saturday"}await PostSomeStuff(new { Day = DayOfWeek.Saturday });由于默认静态配置是全局设置，它们将影响您的整个应用程序。有时候我们只想要对某些特定API进行设置，您可以选择使用RefitSettings属性，以允许您指定所需的序列化程序进行设置，这使您可以为单独的API设置不同的序列化程序设置：
var gitHubApi = RestService.For("https://api.github.com", new RefitSettings { ContentSerializer = new JsonContentSerializer( new JsonSerializerSettings { ContractResolver = new () } )});var otherApi = RestService.For("https://api.example.com", new RefitSettings { ContentSerializer = new JsonContentSerializer( new JsonSerializerSettings { 电脑 ContractResolver = new () } )});还可以使用Json.NET的JsonProperty属性来自定义属性序列化/反序列化：
public class Foo{ //像[AliasAs(“ b”)]一样会在表单中发布 [JsonProperty(PropertyName="b")] public string Bar { get; set; }} 7.2XML内容XML请求和响应使用System.XML.Serialization.XmlSerializer进行序列化/反序列化。默认情况下，Refit只会使用JSON将内容序列化，若要使用XML内容，请将ContentSerializer配置为使用XmlContentSerializer：
var gitHubApi = RestService.For("https://www.w3.org/XML", new RefitSettings { ContentSerializer = new XmlContentSerializer()});属性序列化/反序列化可以使用System.Xml.serialization命名空间中的属性进行自定义：
public class Foo{ [XmlElement(Namespace = "https://www.w3.org/XML")] public string Bar { get; set; }}System.Xml.Serialization.XmlSerializer提供了许多序列化选项，可以通过向XmlContentSerializer构造函数提供XmlContentSerializer设置来设置这些选项：
var 电脑 gitHubApi = RestService.For("https://www.w3.org/XML", new RefitSettings { ContentSerializer = new XmlContentSerializer( new XmlContentSerializerSettings { XmlReaderWriterSettings = new XmlReaderWriterSettings() { ReaderSettings = new XmlReaderSettings { IgnoreWhitespace = true } } } )});7.3.表单发布(Form posts)对于以表单形式发布（即序列化为application/x-www-form-urlencoded）的API，请使用初始化Body属性BodySerializationMethod.UrlEncoded属性，参数可以是IDictionary字典，例：
public interface IMeasurementProtocolApi{ [Post("/collect")] Task Collect([Body(BodySerializationMethod.UrlEncoded)] Dictionary data);}var data = new Dictionary { {"v", 1}, {"tid", "UA-1234-5"}, {"cid", new Guid("d1e9ea6b-2e8b-4699-93e0-0bcbd26c206c")}, {"t", "event"},};// Serialized as: v=1&tid=UA-1234-5&cid=d1e9ea6b-2e8b-4699-93e0-0bcbd26c206c&t=eventawait api.Collect(data);如果我们传递对象跟请求表单中字段名称不一致时，可在对象属性名称上加入[AliasAs("你定义字段名称")] 属性，那么加入属性的对象字段都将会被序列化为请求中的表单字段：
public interface IMeasurementProtocolApi{ [Post("/collect")] Task Collect([Body(BodySerializationMethod.UrlEncoded)] Measurement measurement);}public class Measurement{ // Properties can be read-only and [AliasAs] isn't required public int v { get { return 1; } } [AliasAs("tid")] public string WebPropertyId { get; set; } [AliasAs("cid")] public Guid ClientId { get; set; } [AliasAs("t")] public string Type { get; set; } public object IgnoreMe { private get; set; }}var measurement = new Measurement { WebPropertyId = "UA-1234-5", ClientId = new Guid("d1e9ea6b-2e8b-4699-93e0-0bcbd26c206c"), Type = "event"};// Serialized as: v=1&tid=UA-1234-5&cid=d1e9ea6b-2e8b-4699-93e0-0bcbd26c206c&t=eventawait api.Collect(measurement);8.设置请求头8.1静态头(Static headers)您可以为将headers属性应用于方法的请求设置一个或多个静态请求头：
[Headers("User-Agent: Awesome Octocat App")][Get("/users/{user}")]Task GetUser(string user);通过将headers属性应用于接口，还可以将静态头添加到API中的每个请求：
[Headers("User-Agent: Awesome Octocat App")]public interface IGitHubApi{ [Get("/users/{user}")] Task GetUser(string user); [Post("/users/new")] Task CreateUser([Body] User user);}8.2动态头(Dynamic headers)如果需要在运行时设置头的内容，则可以通过将头属性应用于参数来向请求添加具有动态值的头：
[Get("/users/{user}")]Task GetUser(string user, [Header("Authorization")] string authorization);// Will add the header "Authorization: token OAUTH-TOKEN" to the requestvar user = await GetUser("octocat", "token OAUTH-TOKEN"); 8.3授权(动态头rex)使用头的最常见原因是为了授权。而现在大多数API使用一些oAuth风格的访问令牌，这些访问令牌会过期，刷新寿命更长的令牌。封装这些类型的令牌使用的一种方法是，可以插入自定义的HttpClientHandler。这样做有两个类：一个是，它接受一个Func<Task>参数，在这个参数中可以生成签名，而不必知道请求。另一个是，它接受一个Func<HttpRequestMessage，Task>参数，其中签名需要有关请求的信息（参见前面关于Twitter的API的注释），例如：
class : HttpClientHandler{ private readonly Func<Task> getToken; public (Func<Task> getToken) { if (getToken == null) throw new ArgumentNullException(nameof(getToken)); this.getToken = getToken; } protected override async Task SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) { // See if the request has an authorize header var auth = request.Headers.Authorization; if (auth != null) { var token = await getToken().ConfigureAwait(false); request.Headers.Authorization = new AuthenticationHeaderValue(auth.Scheme, token); } return await base.SendAsync(request, cancellationToken).ConfigureAwait(false); }}或者：
class : DelegatingHandler { readonly Func<HttpRequestMessage, Task> getToken; public (Func<HttpRequestMessage, Task> getToken, HttpMessageHandler innerHandler = null) : base(innerHandler ?? new HttpClientHandler()) { this.getToken = getToken ?? throw new ArgumentNullException(nameof(getToken)); } protected override async Task SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) { // See if the request has an authorize header var auth = request.Headers.Authorization; if (auth != null) { var token = await getToken(request).ConfigureAwait(false); request.Headers.Authorization = new AuthenticationHeaderValue(auth.Scheme, token); } return await base.SendAsync(request, cancellationToken).ConfigureAwait(false); } }虽然HttpClient包含一个几乎相同的方法签名，但使用方式不同。重新安装未调用HttpClient.SendAsync。必须改为修改HttpClientHandler。此类的用法与此类似（示例使用ADAL库来管理自动令牌刷新，但主体用于Xamarin.Auth或任何其他库：
class LoginViewModel{ AuthenticationContext context = new AuthenticationContext(...); private async Task GetToken() { // The AcquireTokenAsync call will prompt with a UI if necessary // Or otherwise silently use a refresh token to return // a valid access token var token = await context.AcquireTokenAsync("http://my.service.uri/app", "clientId", new Uri("callback://complete")); return token; } public async Task LoginAndCallApi() { var api = RestService.For(new HttpClient(new (GetToken)) { BaseAddress = new Uri("https://the.end.point/") }); var location = await api.GetLocationOfRebelBase(); }}interface IMyRestService{ [Get("/getPublicInfo")] Task SomePublicMethod(); [Get("/secretStuff")] [Headers("Authorization: Bearer")] Task GetLocationOfRebelBase();}在上面的示例中，每当调用需要身份验证的方法时，将尝试获取新的访问令牌。由应用程序提供，检查现有访问令牌的过期时间，并在需要时获取新的访问令牌。
电脑