等..…. 哈喽大家好啊，今天我们来聊点稍微有点技术含量的东西。其实就是关于怎么搞一个SDK， 听起来很高大上，其实也就是怎么少写点代码，怎么偷懒，怎么把事情搞得简单点。

一、 写代码真的很累，特别是重复的活儿

大家都是程序员，都知道写代码有多痛苦。每天对着屏幕，眼睛都瞎了头发也掉光了。 我的看法是... 最痛苦的不是写新功能，而是那些重复的活儿，就像是一个无底洞，永远填不满。

1.1 这种感觉怎么形容呢？

这种感觉就像是每天都要吃白米饭，没有任何菜。枯燥，乏味，让人想吐。比如说 我们的系统其实吧是由很多子系统构成的， C位出道。 今天我在这个系统里封装了OA接口，明天在再说一个一个系统可能还要需要使用，那么可能又要封装一次。

极度舒适。 其实上面的操作比较简单，我们只需要。一切顺利。

看着好像挺简单的对吧？但是你想想，如果你有十个系统，每个系统都要搞一遍这个，那你岂不是要累死？你的手指头都要按断了。而且万一明天老板说这个OA接口要改一下或者换个域名，那你岂不是要在一堆代码里找来找去？找得头都大了再说说发现只是改了一个配置文件，你看啊...。

1.2 这时候， 我们就需要一个神器

多损啊！ 这时候，就需要一个神器来拯救我们了。这个东西就叫SDK。SDK就是Software Development Kit的缩写，翻译过来就是软件开发工具包。听着像是什么高科技武器，其实就是一堆已经写好的代码，你拿过来就能用，不用自己再从头写了。

火候不够。 但是很多公司根本就没有这个意识。他们觉得写一个SDK很麻烦，还要维护，还要发布，还不如直接复制粘贴代码算了。这就导致了技术债务越积越多，再说说变成了一堆屎山代码，想改都改不动了。

二、 搞一个SDK，到底要搞哪些东西？

很多人问我，搞个SDK到底难不难？我说难也难，说简单也简单。主要看你想不想偷懒。 C位出道。 如果你想把事情搞砸，那肯定难。如果你想提升效率，那肯定简单。

2.1 第一步：先把Maven项目搭起来

搞Java开发的，谁不知道Maven啊？Maven就是我们的亲爹。先说说你得创建一个Maven项目， GroupId是什么ArtifactId是什么Version是什么。这些名字写错了也没事，反正只要能跑起来就行。

然后你需要引入一些依赖。比如Lombok，这个工具很好用，能少写很多getter和setter。还有Spring Boot的起步包，没有它你连个Spring上下文都启动不起来。还有日志框架，Logback或者Log4j2，随便选一个吧，别太纠结。

搭建环境这一步很关键，环境没搭好，后面什么都别想干。 白嫖。 就像你连车都没发动，就想开车上高速，那不是找死吗？

2.2 第二步：定义配置文件

SDK的核心是什么？是配置。没有配置，你的SDK就是个空壳子。配置文件一般放在`src/main/resources`目录下。文件名叫什么？`application.yml`？`application.properties`？或者干脆叫`config.txt`？随你便吧，只要你的程序能读得懂。

在配置文件里你需要写一些键值对。比如数据库的地址、端口号、账号密码。还有第三方服务的AppKey和AppSecret。这些东西都很敏感，千万别直接写死在代码里不然代码一泄露，你的数据就全没了。虽然我也经常犯这种错，但还是要提醒一下大家，不地道。。

纯正。 配置文件写完了你还得写一个Java类来读取这些配置。这个类就叫`ConfigProperties`。你可以用注解`@ConfigurationProperties`， 也可以不用，直接用`@Value`一个一个取。反正只要能拿到值就行，管他什么设计模式呢？

2.3 第三步：写业务逻辑代码

有啥用呢？ 这部分是最痛苦的。你需要把你那些重复的代码提取出来封装成一个Service。这个Service要提供一些公共的方法。比如`getData`，`setConfig`之类的。

写代码的时候一定要细心。特别是异常处理。如果网络断了怎么办？如果参数传错了怎么办？如果对方服务器崩了怎么办？你总不能让程序直接崩溃吧？那样老板会骂人的，很棒。。

所以你需要加很多`try-catch`块。但是`try-catch`写多了代码就会变得很丑。到处都是`catch `。其实这样也无所谓，只要代码能跑通，不报错，那就是好代码，反正吧…。

三、 发布SDK是一件很玄学的事情

代码写完了你以为就完事了吗？天真！还有最重要的一步，发布。怎么发布呢？上传到Maven中央仓库？那太麻烦了还要审核。上传到公司内部的Nexus仓库？这个还行，但是得有权限，我比较认同...。

3.1 本地安装一下

先说说你得在本地安装一下这个SDK。命令是`mvn clean install`。这个命令很神奇，它会编译你的代码，打包成jar包，然后安装到你本地的Maven仓库里。你可以在`~/.m2/repository`目录下找到它。

安装完之后你就可以在其他项目中使用了。比如在另一个子项目里 你可以在`pom.xml`里加上：

com.example   my-awesome-sdk   1.0.0，换言之...

我们都曾是... 加上这行代码，你的项目就能引用这个SDK了。这就像是你买了一双鞋，穿上它就能走路了。

3.2 真正的发布

但是这只是本地的。别的同事怎么用呢？你总不能一个个发jar包给他们吧？ 说句可能得罪人的话... 那样太low了。你需要把SDK发布到私服或者公网上。

这就需要配置Maven的`settings.xml`文件。在里面配置你的私服地址，比如`nexus.company.com`。然后配置你的用户名和密码。配置好了之后运行`mvn deploy`命令。这个命令会把你的jar包上传到私服上。

上传成功后你的同事就可以在他们的`pom.xml`里引用这个版本了。他们只需要改一下版本号，然后`mvn clean install`一下就能下载到你的SDK了，搞一下...。

四、 使用SDK的时候，坑真的很多

你以为发布了SDK就万事大吉了吗？错！使用SDK的人，才是最痛苦的。主要原因是他们会遇到各种各样的问题，你想...。

4.1 版本冲突

这是最常见的问题。你的SDK依赖了Spring Boot 2.3，但是他们的项目依赖了Spring Boot 2.5。 调整一下。 这就导致了版本冲突。有时候，你的SDK能用，他们的项目就不能用。

解决这个问题的方法， 就是使用`mvn dependency:tree`命令，查看一下依赖树，找出冲突的包，然后用`exclusions`排除掉。但是排除包也是个技术活，搞不好就会漏掉东西，导致程序跑不起来。

4.2 配置加载失败

有时候， SDK明明已经发布成功了但是同事在用的时候，报了个错：`Configuration not found`。这就很尴尬了。

那必须的！ 这是主要原因是配置文件没有正确加载。可能是路径写错了可能是类路径不对，可能是没有加`@Configuration`注解。这时候，你只能让同事去Debug，看看是不是你的代码写错了。

五、 一下反正也没人看

打造一个高效的系统配置SDK，是一件非常有意义的事情。它可以大大提升开发效率， 简单来说... 减少重复劳动，让你的代码更规范，更易维护。

但是做SDK也不是一件容易的事。你需要懂Maven，懂Spring Boot，懂设计模式，还得懂一点点心理学。毕竟你要考虑到使用你SDK的人，他们的技术水平可能参差不齐，可能连Maven都不会用。

所以如果你想做SDK，请务必三思而后行。主要原因是写SDK真的很累，特别是当你发现有个bug修了三天还没修好的时候。但是如果你坚持下来了 你会发现，当你看到别人在你的SDK上顺利运行程序的时候，那种成就感是无法言喻的，到时候…..。

好了废话说了这么多，也不知道大家听懂了没有。反正我是懂了。今天就写到这里吧， 我开心到飞起。 我要去喝杯水，休息一下眼睛。毕竟写代码是很伤身体的，我们要爱惜自己。

我CPU干烧了。 如果你觉得这篇文章对你有帮助，请点个赞，转发一下。如果你觉得这篇文章很烂，也请点个赞，转发一下。反正我是无所谓了。

5.1 再说说的碎碎念

其实 我觉得写文章就像写代码一样，有时候灵感来了一行代码就出来了。 内卷。 有时候，怎么也写不出来对着屏幕发呆半天。这也是一种修行吧。

也许吧... 有时候，我觉得自己像个工匠，在敲敲打打。有时候，我觉得自己像个诗人，在抒发情感。其实我就是一个码农，在为生活奔波。

希望大家都能写出好代码，都能写出好文章。都能找到好工作，都能娶到好老婆。 反思一下。 都能过上幸福的生活。如果不幸福，那可能是你的代码写得不好。

好了真的不说了我要去搬砖了。砖头很重，但我不能放弃。 多损啊！ 为了生活，为了梦想，为了老婆孩子热炕头。

再见！

---