开发SDK

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

    SDK依赖了三个jar包

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

    比如获取故事信息接口

    • 接口名：alipay.story.find
    • 版本号：1.0
    • 参数：name 故事名称
    • 返回信息

    针对这个接口，封装步骤如下：

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

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

    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. }

    使用方式

    如果不想添加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);
    10.     // 发送请求
    11.     CommonResponse response = client.execute(request);
    13.     if (response.isSuccess()) {
    14.         // 返回结果，body对应的是alipay_story_find_response部分
    15.         String body = response.getBody();
    16.         JSONObject jsonObject = JSON.parseObject(body);
    17.         System.out.println(jsonObject);
    18.     } else {
    19.         System.out.println(response);
    20.     }
    21. }

    sdk-.net

    接口封装步骤

    比如获取故事信息接口

    • 接口名：alipay.story.find
    • 参数：name 故事名称
    • 返回信息
    1. {
    2.     "alipay_story_find_response": {
    3.         "msg": "Success",
    4.         "code": "10000",
    5.         "name": "白雪公主",
    6.         "id": 1,
    7.         "gmtCreate": 1554193987378
    8.     },
    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

    里面填写返回的字段

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

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

    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.     }
    11. }
    1. class MainClass
    2. {
    3.     static string url = "http://localhost:8081/api"; // zuul
    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=";
    9.     // 声明一个就行
    10.     static OpenClient client = new OpenClient(url, appId, privateKey);
    12.     public static void Main(string[] args)
    13.     {
    14.         TestGet();
    15.     }
    17.     // 标准用法
    18.     private static void TestGet()
    19.     {
    20.         // 创建请求对象
    21.         // 请求参数
    22.         GetStoryModel model = new GetStoryModel();
    23.         model.Name = "白雪公主";
    24.         request.BizModel = model;
    26.         // 发送请求
    27.         GetStoryResponse response = client.Execute(request);
    29.         if (response.IsSuccess())
    30.         {
    31.             // 返回结果
    32.             Console.WriteLine("故事名称:{0}", response.Name);
    33.         }
    34.         else
    35.         {
    36.             Console.WriteLine("错误, code:{0}, msg:{1}, subCode:{2}, subMsg:{3}", 
    37.                 response.Code, response.Msg, response.SubCode, response.SubMsg);
    38.         }
    39.     }
    42. }

    使用方式2(懒人版)

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

    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.     };
    12.     request.BizModel = bizModel;
    14.     // 发送请求
    15.     CommonResponse response = client.Execute(request);
    17.     if (response.IsSuccess())
    18.     {
    19.         // 返回结果
    20.         string body = response.Body;
    21.         Dictionary<string, object> dict = JsonUtil.ParseToDictionary(body);
    23.         Console.WriteLine("Dictionary内容:");
    24.         foreach (var item in dict)
    25.         {
    26.             Console.WriteLine("{0}:{1}", item.Key, item.Value);
    27.         }
    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.     }