SDK开发
开发starter的好处:引入starter之后,可以在配置文件中配置,自动生成客户端使用。
步骤
1. 创建一个初始化SpringBoot项目,选择相关依赖:
Lombook:日志注解
第二个注解是为了关键词提示用的,后面可以看到。
2. 处理pom文件,删除其中的build依赖项,不需要进行构建。此外配置相关的版本号
3. 编写相关代码逻辑
4. 配置文件目录
# spring boot starter
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.ydyapiclientsdk.YdyApiClientConfig
注意:这里等号后面的是你需要暴露出去的东西,也就是指定为你的配置类。这样它才能被加载到,从而被SpringBoot识别到。
注意:test中的测试类需要删除,因为不构建test,否则有可能报错。
5. 使用maven进行构建,将打包的项目下载到本地的maven仓库中。
6. 在其他项目中引入
之后便可以正常调用。
这里说明一下上面第二个注解的作用:
查看starter的源码,可以看到如下文件
里面配置了提示词相关的东西,也就是代码提示内容
{
"groups": [
{
"name": "ydy.api.client",
"type": "com.example.ydyapiclientsdk.YdyApiClientConfig",
"sourceType": "com.example.ydyapiclientsdk.YdyApiClientConfig"
}
],
"properties": [
{
"name": "ydy.api.client.access-key",
"type": "java.lang.String",
"sourceType": "com.example.ydyapiclientsdk.YdyApiClientConfig"
},
{
"name": "ydy.api.client.secret-key",
"type": "java.lang.String",
"sourceType": "com.example.ydyapiclientsdk.YdyApiClientConfig"
}
],
"hints": []
}
也就是配置文件中的提示: