网络请求Request

appcan.ajax(options)

发起一个ajax请求,并获取相应的内容

1. options:发起ajax的请求的参数，这个必须是一个对象
2. options.type:请求的类型，包括GET、POST等
3. options.appVerify:是否在请求头中加入appVerify字段 true、false
4. options.certificate({password:'',path:'default'})添加证书信息
5. 　 password:数字证书密码。当使用appcan默认证书时，此参数为空(或””)
6. 　 path:路径，支持 file://,res://,wgt://等协议路径，详见CONSTANT中PathTypes。 当传入‘default’时，本次请求将取appcan默认数字证书。
7. options.url:要请求的地址 注：get方式请求中携带中文参数，需要对参数进行encode编码，具体函数：encodeURIComponent
8. options.data:要请求的URL的参数,如果要上传文件则data数据中必须传一个对象包含一个path的key 例如：data:{file:{path:'a.jpeg'},file2:{path:'b.jpeg'}}上传a.jpeg,b.jpeg图片
9. options.contentType:默认: false 要传给服务端的数据内容的'content-Type'通过header,如果设置其他content将会直接把data发送出去
10. options.dataType:服务端的响应类型，包括json, jsonp, script, xml, html, text中的一种
11. options.timeout:请求的超时时间
12. options.headers:要设置的请求头
13. options.xhrFields:要重载的请求对象的字段
14. options.beforeSend(xhr, settings):请求发送之前的回调,返回false取消请求发送
15. options.success(data, status,,requestCode,response, xhr):请求发送成功后的回调
16. 　 requestCode: 服务器响应状态码,成功为200，失败为404,-1等；
17. 　reponse: JSON格式字符串：
18. {
19. "responseHeaders": “”,//请求头
20. "responseStatusCode": “”,//状态码
21. "responseStatusMessage": “”,//状态码的信息
22. "responseError": “”//错误信息
23. }
24. options.error(xhr, errorType, error,msg):请求如果出现错误后的回调;msg: 错误详细信息，服务器返回的result信息
25. options.complete(xhr, status):请求完成后的回调，不管是否出错
26. options.progress(progress, xhr):上传的进度，只有包含上传文件的时候才会执行该回调
27. options.cache:是否缓存请求
28. options.offline:是否直接调用离线数据，包括true,false,undefined
29. 　　　**offline参数说明：**
30. 　　　　 true: 直接调用缓存数据，如果缓存数据不存在，执行ajax请求并离线缓存返回数据；
31. 　　　　 false: 直接请求ajax数据，并把请求到的数据离线缓存；
32. 　　　　undefined: 直接请求ajax数据，不缓存请求到的数据；
33. options.offlineDataPath:自定义离线数据文件存储目录
34. options.expires:离线缓存过期时间，支持类型：
35. 　1.number类型（单位：毫秒），缓存过期时长，
36. 　2.W3c IOS 8601 DateTime格式,详见http://www.w3.org/TR/NOTE-datetime ，缓存过期时间点
37. options.crypto:true/false 离线缓存时是否加密
38. options.password: "string" 离线缓存加密密码

例如：

1. appcan.ajax({
2. url : 'http://weixin.appcan.cn:8086/test/get',
3. type : 'GET',
4. data : {
5. a : 'hello word',
6. b : 'page'
7. },
8. offline : true,
9. offlineDataPath : 'wgt://aaa/',
10. success : function(data) {
11. alert(data);
12. },
13. error : function(e) {
14. alert(e);
15. }
16. });

例如：

1. A.number格式
4. appcan.ajax({
5. url : 'http://weixin.appcan.cn:8086/test/get',
6. type : 'GET',
7. data : {
8. a : 'hello word',
9. b : 'page'
10. },
11. offline : true,
12. expires:3000,
13. success : function(data) {
14. alert(data);
15. }, error : function(e) {
16. alert(e);
17. }
18. });
22. B.ISO 8601格式
24. appcan.ajax({
25. url : 'http://weixin.appcan.cn:8086/test/get',
26. type : 'GET',
27. data : {
28. a : 'hello word',
29. b : 'page'
30. },
31. offline : true,
32. expires : '2015-05-16 ',
33. success : function(data) {
34. alert(data);
35. },
36. error : function(e) {
37. alert(e);
38. }
39. });

例如：

1. appcan.ajax({
2. url:http://115.29.138.150:8086/test/get,
3. type:"GET",
4. data:{}, dataType:"json",
5. timeout:30000,
6. success:function(data, status, requestCode, response, xhr) {
7. alert("status:" + status);
8. alert("result:" + data);
9. alert("requestCode:" + requestCode);
10. alert("response:" + JSON.stringify(response));
11. alert("xhr:" + JSON.stringify(xhr));
12. }, error:function(xhr,erroType,error,msg) {
13. alert("erroType:" + erroType);
14. alert("error:" + error);
15. alert("msg:" + msg);
16. alert("xhr:" + JSON.stringify(xhr));
17. }
19. });
22. //获取appcan.cn页面
23. appcan.ajax({
24. type : 'GET',
25. url : 'http://appcan.cn',
26. //添加参数
27. data : {
28. name : 'appcan'
29. },
30. //期望的返回类型
31. dataType : 'html',
32. timeout : 300, //超时时间
33. success : function(data) {
34. //获取内容
35. alert('data');
36. },
37. error : function(xhr, type) {
38. alert('Ajax error!')
39. },
40. offline : true
41. })

离线缓存加解密例子：

1. appcan.ajax({
2. url : "http://weixin.appcan.cn:8086/test/get",
3. type : "GET",
4. data : {
5. a : 'hello word',
6. b : 'page'
7. },
8. dataType : "json",
9. timeout : 30000,
10. offline : true,
11. crypto : true,
12. password : "pwd",
13. success : function(data, status, requestCode, response, xhr) {
14. alert("status:" + status);
15. alert("result:" + data);
16. alert("requestCode:" + requestCode);
17. alert("response:" + JSON.stringify(response));
18. alert("xhr:" + JSON.stringify(xhr));
19. },
20. error : function(xhr, erroType, error, msg) {
21. alert("erroType:" + erroType);
22. alert("error:" + error);
23. alert("msg:" + msg);
24. alert("xhr:" + JSON.stringify(xhr));
25. }
26. });

appcan.request.ajax(options)

请参考 ：appcan.ajax(options)发起一个ajax请求,并获取相应的内容

1. options:发起ajax的请求的参数，这个必须是一个对象
2. options.type:请求的类型，包括GET、POST等
3. options.appVerify:是否在请求头中加入appVerify字段 true、false
4. options.url:要请求的地址 注：get方式请求中携带中文参数，需要对参数进行encode编码，具体函数：encodeURIComponent
5. options.data:要请求的URL的参数,如果要上传文件则data数据中必须传一个对象包含一个path的key 例如：data:{file:{path:'a.jpeg'}}上传a.jpeg图片
6. options.contentType:默认: false 要传给服务端的数据内容的'content-Type'通过header,如果设置其他content将会直接把data发送出去
7. options.dataType:服务端的响应类型，包括json, jsonp, script, xml, html, text中的一种
8. options.timeout:请求的超时时间
9. options.headers:要设置的请求头
10. options.xhrFields:要重载的请求对象的字段
11. options.beforeSend(xhr, settings):请求发送之前的回调,返回false取消请求发送
12. options.success(data, status,requestCode,response, xhr):请求发送成功后的回调　
13. 　　**requestCode、reponse说明：**　
14. 　　　 requestCode: 服务器响应状态码,成功为200，失败为404,-1等；
15. 　　　 reponse: JSON格式字符串：
16. 　　　{
17. 　　　　"responseHeaders": “”,//请求头
18. 　　　　"responseStatusCode": “”,//状态码
19. 　　　　"responseStatusMessage": “”,//状态码的信息
20. 　　　　"responseError": “”//错误信息
21. 　　　}
22. options.error(xhr, errorType, error,msg):请求如果出现错误后的回调;msg: 错误详细信息，服务器返回的result信息
23. options.complete(xhr, status):请求完成后的回调，不管是否出错
24. options.progress(progress, xhr):上传的进度，只有包含上传文件的时候才会执行该回调
25. options.certificate:添加证书信息 {password:'',path:''}其中password是证书的密码，path是证书的地址
26. options.cache:是否缓存请求
27. options.offline:是否直接调用离线数据，包括true,false,undefined
28. 　　**offline参数说明：**
29. 　　 true: 直接调用缓存数据，如果缓存数据不存在，执行ajax请求并离线缓存返回数据；
30. 　　false: 直接请求ajax数据，并把请求到的数据离线缓存；
31. 　　undefined: 直接请求ajax数据，不缓存请求到的数据；
32. options.offlineDataPath:自定义离线数据文件存储目录
33. options.expires:离线缓存过期时间，支持类型：
34. 　1.number类型（单位：毫秒），缓存过期时长，
35. 　2.W3c IOS 8601 DateTime格式,详见http://www.w3.org/TR/NOTE-datetime ，缓存过期时间点
36. options.crypto:true/false 离线缓存时是否加密
37. options.password: "string" 离线缓存加密密码

例如：

1. appcan.ajax({
2. url : 'http://weixin.appcan.cn:8086/test/get',
3. type : 'GET',
4. data : {
5. a : 'hello word',
6. b : 'page'
7. },
8. offline : true,
9. offlineDataPath : 'wgt://aaa/',
10. success : function(data) {
11. alert(data);
12. },
13. error : function(e) {
14. alert(e);
15. }
16. });
17. 例如:
18. A.number格式
20. appcan.ajax({
21. url : 'http://weixin.appcan.cn:8086/test/get',
22. type : 'GET',
23. data : {
24. a : 'hello word',
25. b : 'page'
26. },
27. offline : true,
28. expires:3000,
29. success : function(data) {
30. alert(data);
31. }, error : function(e) {
32. alert(e);
33. }
34. });
36. B.ISO 8601格式
38. appcan.request.ajax({
39. url : 'http://weixin.appcan.cn:8086/test/get',
40. type : 'GET',
41. data : {
42. a : 'hello word',
43. b : 'page'
44. },
45. offline : true,
46. expires : '2015-05-16 ',
47. success : function(data) {
48. alert(data);
49. },
50. error : function(e) {
51. alert(e);
52. }
53. });

例如：

1. appcan.request.ajax({
2. url:http://115.29.138.150:8086/test/get,
3. type:"GET",
4. data:{}, dataType:"json",
5. timeout:30000,
6. success:function(data, status, requestCode, response, xhr) {
7. alert("status:" + status);
8. alert("result:" + data);
9. alert("requestCode:" + requestCode);
10. alert("response:" + JSON.stringify(response));
11. alert("xhr:" + JSON.stringify(xhr));
12. }, error:function(xhr,erroType,error,msg) {
13. alert("xhr:" + JSON.stringify(xhr));
14. alert("erroType:" + erroType);
15. alert("error:" + error);
16. alert("msg:" + msg);
17. }
19. });
22. //获取appcan.cn页面
24. appcan.request.ajax({
25. type : 'GET',
26. url : 'http://appcan.cn',
27. //添加参数
28. data : {
29. name : 'appcan'
30. },
31. //期望的返回类型
32. dataType : 'html',
33. timeout : 300, //超时时间
34. success : function(data) {
35. //获取内容
36. alert('data');
37. },
38. error : function(xhr, type) {
39. alert('Ajax error!')
40. },
41. offline : true
42. })
45. //另外一种使用方式
47. var request = appcan.require('request');
48. request.ajax({
49. type : 'POST',
50. url : 'http://appcan.cn/reg',
51. data : {
52. name : 'appcan'
53. },
54. contentType : 'application/json',
55. success : function() {
57. }
58. })
61. //获取appcan.cn页面
63. appcan.request.ajax({
64. type : 'GET',
65. url : 'http://appcan.cn',
66. //添加参数
67. data : {
68. name : 'appcan'
69. },
70. //期望的返回类型
71. dataType : 'html',
72. timeout : 300, //超时时间
73. success : function(data) {
74. //获取内容
75. alert('data');
76. },
77. error : function(xhr, type) {
78. alert('Ajax error!')
79. }
80. })
83. //例如发送一个post请求,地址为模拟用
85. request.ajax({
86. type : 'POST',
87. url : 'http://appcan.cn/reg',
88. data : {
89. name : 'appcan'
90. },
91. contentType : 'application/json',
92. success : function() {
94. }
95. })

离线缓存加解密例子：

1. appcan.ajax({
2. url : "http://weixin.appcan.cn:8086/test/get",
3. type : "GET",
4. data : {
5. a : 'hello word',
6. b : 'page'
7. },
8. dataType : "json",
9. timeout : 30000,
10. offline : true,
11. crypto : true,
12. password : "pwd",
13. success : function(data, status, requestCode, response, xhr) {
14. alert("status:" + status);
15. alert("result:" + data);
16. alert("requestCode:" + requestCode);
17. alert("response:" + JSON.stringify(response));
18. alert("xhr:" + JSON.stringify(xhr));
19. },
20. error : function(xhr, erroType, error, msg) {
21. alert("erroType:" + erroType);
22. alert("error:" + error);
23. alert("msg:" + msg);
24. alert("xhr:" + JSON.stringify(xhr));
25. }
26. });

appcan.request.get(url,[data],success,[dataType])

发一个http Get请求，这是appcan.request.ajax的简写

1. url:要请求的地址
2. data:该参数不是必须的，要传递的参数
3. success:成功后的回调函数，参考appcan.request.ajax参数中的success
4. dataType:返回的响应结果的数据类型

例如：

1. //请求appcan.cn页面的内容
3. appcan.request.get('http://appcan.cn', function(data, status, xhr) {
4. //数据内容
5. console.log(data);
6. });
7. //另外一种使用方式
8. var request = appcan.require('request');
9. request.get('http://appcan.cn', function(data, status, xhr) {
10. //数据内容
11. console.log(data);
12. });
14. appcan.request.post(url, [data], success,[dataType])
15. 发起一个http Post请求
16. url:要请求的地址
17. data:要发出的请求的参数
18. success:请求的成功的回调
19. dataType:返回的响应结果的数据类型
20. 例如:
21. //发送一个简单的post数据到appcan.cn
23. appcan.request.post('http://appcan.cn', {
24. name : 'appcan'
25. }, function(data, status, xhr) {
26. //打印结果
27. console.log(data);
28. });
30. //另外一种使用方式
32. var request = appcan.require('request');
33. request.post('http://appcan.cn', {
34. name : 'appcan'
35. }, function(data, status, xhr) {
36. //打印结果
37. console.log(data);
38. });

appcan.request.getJSON(url,[data],success)

发起一个http get请求来获取json数据

1. url:要获取的json数据的地址
2. data:要发送请求的参数
3. success:成功后的回调

例如：

1. //获取一个json数据
3. appcan.request.getJSON('http://appcan.cn/a.json', function(data) {
4. //打印json数据
5. console.log(data);
6. });
8. //另一种使用方式
10. var request = appcan.require('request');
11. request.getJSON('http://appcan.cn/a.json', function(data) {
12. //打印json数据
13. console.log(data);
14. });

appcan.request.postForm(selector,success,error)

序列化表单内容并提交表单

1. selector:表单的css选择器，或者是form元素
2. success(data):表单提交成功后的回调,data服务器端的返回值
3. error(err):表单提交失败的时候的回调,err错误对象

例如：

1. //获取一个json数据
3. $('form').on('submit', function() {
4. var form = $('from');
5. appcan.request.postForm(form);
6. return false;
7. });
9. //另一种使用方式
11. var request = appcan.require('request');
12. $('form').on('submit', function() {
13. var form = $('from');
14. request.postForm(form);
15. return false;
16. });

appcan.request.clearOffline(url,callback,data)

1. url:需要清除离线数据的url
2. callback(err,data,dataType,optId) : 执行成功后的回调函数
3. data:与appcan.request.ajax参数中的data相同

例如：

1. //清除指定url的离线缓存数据
3. appcan.request.clearOffline({
4. url : 'http://weixin.appcan.cn:8086/test/get',
5. callback : function(err, data, dataType, optId) {
6. if (err) {
7. //清除缓存错误
8. return;
9. }
10. if (data == 0) {
11. //清除缓存成功
12. } else {
13. //清除缓存失败
14. }
15. }
16. });

例如：

1. //清除指定url的离线缓存数据
3. appcan.request.clearOffline({
4. url : 'http://weixin.appcan.cn:8086/test/get',
5. callback : function(err, data, dataType, optId) {
6. if (err) {
7. //清除缓存错误
8. return;
9. }
10. if (data == 0) {
11. //清除缓存成功
12. } else {
13. //清除缓存失败
14. }
15. },
16. data:{
17. a : 'hello word',
18. b : 'page'
19. }
20. });
21. a