开发SDK

开放平台把接口开发完毕后,一般需要开发对应的SDK,提供给ISV。SOP提供了一个基础的SDK开发包

开发者可以在此基础上做开发,就拿sdk-java来说,具体步骤如下:

sdk-java

SDK依赖了三个jar包

  • okhttp.jar 用于网络请求
  • fastjson.jar 用于json处理
  • commons-logging.jar 日志处理

接口封装步骤

比如获取故事信息接口

  • 接口名:alipay.story.find
  • 版本号:1.0
  • 参数:name 故事名称
  • 返回信息
  1. {
  2. "alipay_story_find_response": {
  3. "msg": "Success",
  4. "code": "10000",
  5. "name": "白雪公主",
  6. "id": 1,
  7. "gmtCreate": 1554193987378
  8. },
  9. "sign": "xxxxx"
  10. }

针对这个接口,封装步骤如下:

1.在model包下新建一个类,定义业务参数

  1. @Data
  2. public class GetStoryModel {
  3. @JSONField(name = "name")
  4. private String name;
  5. }

2.在response包下新建一个返回类GetStoryResponse,继承BaseResponse

里面填写返回的字段

  1. @Data
  2. public class GetStoryResponse extends BaseResponse {
  3. private Long id;
  4. private String name;
  5. private Date gmtCreate;
  6. }

3.在request包下新建一个请求类,继承BaseRequest

BaseRequest中有个泛型参数,填GetStoryResponse类,表示这个请求对应的返回类。重写method()方法,填接口名。

如果要指定版本号,可重写version()方法,或者后续使用request.setVersion(version)进行设置

  1. public class GetStoryRequest extends BaseRequest<GetStoryResponse> {
  2. @Override
  3. protected String method() {
  4. return "alipay.story.find";
  5. }
  6. }

可重写getRequestMethod()方法指定HTTP请求method,默认是POST。

  1. @Override
  2. protected RequestMethod getRequestMethod() {
  3. return RequestMethod.GET;
  4. }

建议读请求用GET,写请求用POST

使用方式

  1. String url = "http://localhost:8081";
  2. String appId = "2019032617262200001";
  3. String privateKey = "你的私钥";
  4. // 声明一个就行
  5. OpenClient client = new OpenClient(url, appId, privateKey);
  6. // 标准用法
  7. @Test
  8. public void testGet() {
  9. // 创建请求对象
  10. GetStoryRequest request = new GetStoryRequest();
  11. // 请求参数
  12. GetStoryModel model = new GetStoryModel();
  13. model.setName("白雪公主");
  14. request.setBizModel(model);
  15. // 发送请求
  16. GetStoryResponse response = client.execute(request);
  17. if (response.isSuccess()) {
  18. // 返回结果
  19. System.out.println(String.format("成功!response:%s\n响应原始内容:%s",
  20. JSON.toJSONString(response), response.getBody()));
  21. } else {
  22. System.out.println("错误,subCode:" + response.getSubCode() + ", subMsg:" + response.getSubMsg());
  23. }
  24. }

使用方式2(懒人版)

如果不想添加Request,Response,Model。可以用这种方式,返回body部分是字符串,后续自己处理

body对应的是alipay_story_find_response部分

  1. @Test
  2. public void testLazy() {
  3. // 创建请求对象
  4. CommonRequest request = new CommonRequest("alipay.story.find");
  5. // 请求参数
  6. Map<String, Object> bizModel = new HashMap<>();
  7. bizModel.put("name", "白雪公主");
  8. request.setBizModel(bizModel);
  9. // 发送请求
  10. CommonResponse response = client.execute(request);
  11. if (response.isSuccess()) {
  12. // 返回结果,body对应的是alipay_story_find_response部分
  13. String body = response.getBody();
  14. JSONObject jsonObject = JSON.parseObject(body);
  15. System.out.println(jsonObject);
  16. } else {
  17. System.out.println(response);
  18. }
  19. }

sdk-.net

接口封装步骤

比如获取故事信息接口

  • 接口名:alipay.story.find
  • 版本号:1.0
  • 参数:name 故事名称
  • 返回信息
  1. {
  2. "alipay_story_find_response": {
  3. "msg": "Success",
  4. "code": "10000",
  5. "name": "白雪公主",
  6. "id": 1,
  7. "gmtCreate": 1554193987378
  8. },
  9. "sign": "xxxxx"
  10. }

针对这个接口,封装步骤如下:

1.在Model包下新建一个类,定义业务参数

  1. namespace SDKCSharp.Model
  2. {
  3. public class GetStoryModel
  4. {
  5. /// <summary>
  6. /// 故事名称
  7. /// </summary>
  8. /// <value>The name.</value>
  9. [JsonProperty("name")]
  10. public string Name { get; set; }
  11. }
  12. }

[JsonProperty("name")]是Newtonsoft.Json组件中的类,用于Json序列化,括号中的是参数名称。类似于Java中的注解,@JSONField(name = "xx")

2.在Response包下新建一个返回类GetStoryResponse,继承BaseResponse

里面填写返回的字段

  1. namespace SDKCSharp.Response
  2. {
  3. public class GetStoryResponse: BaseResponse
  4. {
  5. [JsonProperty("id")]
  6. public int Id { get; set; }
  7. [JsonProperty("name")]
  8. public string Name { get; set; }
  9. [JsonProperty("gmt_create")]
  10. public string GmtCreate { get; set; }
  11. }
  12. }

3.在Request文件夹下新建一个请求类,继承BaseRequest

BaseRequest中有个泛型参数,填GetStoryResponse类,表示这个请求对应的返回类。重写GetMethod()方法,填接口名。

如果要指定版本号,可重写GetVersion()方法,或者后续使用request.Version = version进行设置

  1. namespace SDKCSharp.Request
  2. {
  3. public class GetStoryRequest : BaseRequest<GetStoryResponse>
  4. {
  5. public override string GetMethod()
  6. {
  7. return "alipay.story.find";
  8. }
  9. }
  10. }

使用方式

  1. class MainClass
  2. {
  3. static string url = "http://localhost:8081";
  4. static string appId = "2019032617262200001";
  5. // 平台提供的私钥
  6. static string privateKey = "MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCXJv1pQFqWNA/++OYEV7WYXwexZK/J8LY1OWlP9X0T6wHFOvxNKRvMkJ5544SbgsJpVcvRDPrcxmhPbi/sAhdO4x2PiPKIz9Yni2OtYCCeaiE056B+e1O2jXoLeXbfi9fPivJZkxH/tb4xfLkH3bA8ZAQnQsoXA0SguykMRZntF0TndUfvDrLqwhlR8r5iRdZLB6F8o8qXH6UPDfNEnf/K8wX5T4EB1b8x8QJ7Ua4GcIUqeUxGHdQpzNbJdaQvoi06lgccmL+PHzminkFYON7alj1CjDN833j7QMHdPtS9l7B67fOU/p2LAAkPMtoVBfxQt9aFj7B8rEhGCz02iJIBAgMBAAECggEARqOuIpY0v6WtJBfmR3lGIOOokLrhfJrGTLF8CiZMQha+SRJ7/wOLPlsH9SbjPlopyViTXCuYwbzn2tdABigkBHYXxpDV6CJZjzmRZ+FY3S/0POlTFElGojYUJ3CooWiVfyUMhdg5vSuOq0oCny53woFrf32zPHYGiKdvU5Djku1onbDU0Lw8w+5tguuEZ76kZ/lUcccGy5978FFmYpzY/65RHCpvLiLqYyWTtaNT1aQ/9pw4jX9HO9NfdJ9gYFK8r/2f36ZE4hxluAfeOXQfRC/WhPmiw/ReUhxPznG/WgKaa/OaRtAx3inbQ+JuCND7uuKeRe4osP2jLPHPP6AUwQKBgQDUNu3BkLoKaimjGOjCTAwtp71g1oo+k5/uEInAo7lyEwpV0EuUMwLA/HCqUgR4K9pyYV+Oyb8d6f0+Hz0BMD92I2pqlXrD7xV2WzDvyXM3s63NvorRooKcyfd9i6ccMjAyTR2qfLkxv0hlbBbsPHz4BbU63xhTJp3Ghi0/ey/1HQKBgQC2VsgqC6ykfSidZUNLmQZe3J0p/Qf9VLkfrQ+xaHapOs6AzDU2H2osuysqXTLJHsGfrwVaTs00ER2z8ljTJPBUtNtOLrwNRlvgdnzyVAKHfOgDBGwJgiwpeE9voB1oAV/mXqSaUWNnuwlOIhvQEBwekqNyWvhLqC7nCAIhj3yvNQKBgQCqYbeec56LAhWP903Zwcj9VvG7sESqXUhIkUqoOkuIBTWFFIm54QLTA1tJxDQGb98heoCIWf5x/A3xNI98RsqNBX5JON6qNWjb7/dobitti3t99v/ptDp9u8JTMC7penoryLKK0Ty3bkan95Kn9SC42YxaSghzqkt+uvfVQgiNGQKBgGxU6P2aDAt6VNwWosHSe+d2WWXt8IZBhO9d6dn0f7ORvcjmCqNKTNGgrkewMZEuVcliueJquR47IROdY8qmwqcBAN7Vg2K7r7CPlTKAWTRYMJxCT1Hi5gwJb+CZF3+IeYqsJk2NF2s0w5WJTE70k1BSvQsfIzAIDz2yE1oPHvwVAoGAA6e+xQkVH4fMEph55RJIZ5goI4Y76BSvt2N5OKZKd4HtaV+eIhM3SDsVYRLIm9ZquJHMiZQGyUGnsvrKL6AAVNK7eQZCRDk9KQz+0GKOGqku0nOZjUbAu6A2/vtXAaAuFSFx1rUQVVjFulLexkXR3KcztL1Qu2k5pB6Si0K/uwQ=";
  7. // 声明一个就行
  8. static OpenClient client = new OpenClient(url, appId, privateKey);
  9. public static void Main(string[] args)
  10. {
  11. TestGet();
  12. }
  13. // 标准用法
  14. private static void TestGet()
  15. {
  16. // 创建请求对象
  17. GetStoryRequest request = new GetStoryRequest();
  18. // 请求参数
  19. GetStoryModel model = new GetStoryModel();
  20. model.Name = "白雪公主";
  21. request.BizModel = model;
  22. // 发送请求
  23. GetStoryResponse response = client.Execute(request);
  24. if (response.IsSuccess())
  25. {
  26. // 返回结果
  27. Console.WriteLine("故事名称:{0}", response.Name);
  28. }
  29. else
  30. {
  31. Console.WriteLine("错误, code:{0}, msg:{1}, subCode:{2}, subMsg:{3}",
  32. response.Code, response.Msg, response.SubCode, response.SubMsg);
  33. }
  34. }
  35. }

使用方式2(懒人版)

如果不想添加Request,Response,Model。可以用这种方式,返回data部分是Dictionary,后续自己处理

  1. // 懒人版,如果不想添加Request,Response,Model。可以用这种方式,返回Dictionary<string, object>,后续自己处理
  2. private static void TestCommon()
  3. {
  4. // 创建请求对象
  5. CommonRequest request = new CommonRequest("alipay.story.find");
  6. // 请求参数
  7. Dictionary<string, string> bizModel = new Dictionary<string, string>
  8. {
  9. ["name"] = "白雪公主"
  10. };
  11. request.BizModel = bizModel;
  12. // 发送请求
  13. CommonResponse response = client.Execute(request);
  14. if (response.IsSuccess())
  15. {
  16. // 返回结果
  17. string body = response.Body;
  18. Dictionary<string, object> dict = JsonUtil.ParseToDictionary(body);
  19. Console.WriteLine("Dictionary内容:");
  20. foreach (var item in dict)
  21. {
  22. Console.WriteLine("{0}:{1}", item.Key, item.Value);
  23. }
  24. }
  25. else
  26. {
  27. Console.WriteLine("错误, code:{0}, msg:{1}, subCode:{2}, subMsg:{3}",
  28. response.Code, response.Msg, response.SubCode, response.SubMsg);
  29. }
  30. }