{"id":6930,"date":"2025-12-01T15:32:12","date_gmt":"2025-12-01T07:32:12","guid":{"rendered":"https:\/\/t.n-years.com\/?p=6930"},"modified":"2025-12-01T15:32:12","modified_gmt":"2025-12-01T07:32:12","slug":"android-%e6%a8%a1%e5%9d%97%e5%85%ac%e5%bc%80-api-%e7%9a%84%e7%89%b9%e5%be%81%e4%b8%8e%e5%8f%98%e6%9b%b4%e7%ae%a1%e6%8e%a7%e6%96%b9%e6%a1%88","status":"publish","type":"post","link":"https:\/\/t.n-years.com\/?p=6930","title":{"rendered":"Android \u6a21\u5757\u516c\u5f00 API \u7684\u7279\u5f81\u4e0e\u53d8\u66f4\u7ba1\u63a7\u65b9\u6848"},"content":{"rendered":"<h1>Android \u6a21\u5757\u516c\u5f00 API \u7684\u7279\u5f81\u4e0e\u53d8\u66f4\u7ba1\u63a7\u65b9\u6848<\/h1>\n<p>\u5728 Android \u5f00\u53d1\u4e2d\uff0c\u6a21\u5757\uff08\u5982 Library \u6a21\u5757\u3001\u4e1a\u52a1\u6a21\u5757\uff09\u7684\u516c\u5f00 API \u662f\u6a21\u5757\u5bf9\u5916\u63d0\u4f9b\u80fd\u529b\u7684\u6838\u5fc3\u5165\u53e3\uff0c\u5176\u8bbe\u8ba1\u548c\u7ba1\u63a7\u76f4\u63a5\u5f71\u54cd\u8de8\u6a21\u5757\u4f9d\u8d56\u7a33\u5b9a\u6027\u3002\u4ee5\u4e0b\u4ece\u300c\u516c\u5f00 API \u7684\u6838\u5fc3\u7279\u5f81\u300d\u300c\u53d8\u66f4\u7ba1\u63a7\u6d41\u7a0b\u300d\u300c\u843d\u5730\u5de5\u5177\u4e0e\u6700\u4f73\u5b9e\u8df5\u300d\u4e09\u90e8\u5206\u5c55\u5f00\u8bf4\u660e\uff1a<\/p>\n<h2>\u4e00\u3001Android \u6a21\u5757\u516c\u5f00 API \u7684\u6838\u5fc3\u7279\u5f81<\/h2>\n<p>\u516c\u5f00 API \u662f\u6a21\u5757\u660e\u786e\u5bf9\u5916\u66b4\u9732\u3001\u5141\u8bb8\u5176\u4ed6\u6a21\u5757\u4f9d\u8d56\u8c03\u7528\u7684\u300c\u7a33\u5b9a\u5951\u7ea6\u300d\uff0c\u5177\u5907\u4ee5\u4e0b\u53ef\u8bc6\u522b\u7279\u5f81\uff08\u533a\u5206\u4e8e\u5185\u90e8\u5b9e\u73b0\u4ee3\u7801\uff09\uff1a<\/p>\n<h3>1. \u4ee3\u7801\u5c42\u9762\u7684\u663e\u6027\u7279\u5f81<\/h3>\n<table>\n<thead>\n<tr>\n<th>\u7279\u5f81\u7ef4\u5ea6<\/th>\n<th>\u5177\u4f53\u8868\u73b0<\/th>\n<th>\u793a\u4f8b<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>\u8bbf\u95ee\u4fee\u9970\u7b26<\/td>\n<td>\u5fc5\u987b\u662f <code>public<\/code>\uff08Kotlin \u4e2d\u9ed8\u8ba4 <code>public<\/code>\uff0c\u9700\u663e\u5f0f\u58f0\u660e\u4e3a <code>internal<\/code> \u6392\u9664\u5185\u90e8\u63a5\u53e3\uff09<\/td>\n<td>Java: <code>public class UserApi { ... }<\/code> <br \/> Kotlin: <code>class UserApi { ... }<\/code>\uff08\u9ed8\u8ba4 public\uff09<\/td>\n<\/tr>\n<tr>\n<td>\u65e0 <code>internal<\/code>\/\u5305\u7ea7\u79c1\u6709\u4fee\u9970<\/td>\n<td>\u6a21\u5757\u5185\u90e8\u4ee3\u7801\u9700\u7528 <code>internal<\/code>\uff08Kotlin\uff09\u3001\u5305\u7ea7\u79c1\u6709\uff08Java \u65e0\u4fee\u9970\u7b26\uff09\u6216 <code>private<\/code> \u9694\u79bb<\/td>\n<td>Kotlin: <code>internal fun internalUtils() { ... }<\/code>\uff08\u975e\u516c\u5f00\uff09<\/td>\n<\/tr>\n<tr>\n<td>\u96c6\u4e2d\u5f0f\u66b4\u9732\uff08\u63a8\u8350\u89c4\u8303\uff09<\/td>\n<td>\u516c\u5f00 API \u7edf\u4e00\u653e\u5728\u56fa\u5b9a\u5305\u540d\u4e0b\uff08\u5982 <code>com.xxx.module.api<\/code>\uff09\uff0c\u907f\u514d\u6563\u843d\u5728\u4e1a\u52a1\u5305\u4e2d<\/td>\n<td>\u5305\u7ed3\u6784\uff1a<code>com.xxx.pay.api.PayApi<\/code>\u3001<code>com.xxx.pay.api.PayCallback<\/code><\/td>\n<\/tr>\n<tr>\n<td>\u65e0\u300c\u5b9e\u73b0\u7ec6\u8282\u6cc4\u9732\u300d<\/td>\n<td>\u516c\u5f00 API \u4f18\u5148\u662f\u63a5\u53e3\uff08<code>interface<\/code>\uff09\u3001\u62bd\u8c61\u7c7b\uff0c\u6216\u5c01\u88c5\u540e\u7684\u5de5\u5177\u7c7b\uff0c\u4e0d\u66b4\u9732\u5185\u90e8\u6210\u5458\u53d8\u91cf\u3001\u5b9e\u73b0\u7c7b<\/td>\n<td>\u53cd\u4f8b\uff1a<code>public class PayImpl { public String apiKey; ... }<\/code>\uff08\u66b4\u9732\u5b9e\u73b0+\u654f\u611f\u5b57\u6bb5\uff09<\/td>\n<\/tr>\n<tr>\n<td>\u6ce8\u89e3\u6807\u8bb0\uff08\u53ef\u9009\uff09<\/td>\n<td>\u7528\u81ea\u5b9a\u4e49\u6ce8\u89e3\u6807\u8bb0\u516c\u5f00 API\uff0c\u4fbf\u4e8e\u5de5\u5177\u8bc6\u522b\uff08\u5982 <code>@PublicApi<\/code>\uff09<\/td>\n<td><code>@PublicApi fun createOrder(): String<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3>2. \u529f\u80fd\u4e0e\u5951\u7ea6\u5c42\u9762\u7684\u7279\u5f81<\/h3>\n<ul>\n<li><strong>\u7a33\u5b9a\u6027\u627f\u8bfa<\/strong>\uff1a\u516c\u5f00 API \u9700\u627f\u8bfa\u300c\u5411\u540e\u517c\u5bb9\u300d\uff08\u9664\u975e\u660e\u786e\u58f0\u660e\u4e3a Beta \u7248\u672c\uff09\uff0c\u5185\u90e8\u63a5\u53e3\u53ef\u968f\u65f6\u53d8\u66f4\uff1b<\/li>\n<li><strong>\u804c\u8d23\u5355\u4e00<\/strong>\uff1a\u516c\u5f00 API \u805a\u7126\u6838\u5fc3\u80fd\u529b\uff08\u5982\u652f\u4ed8\u6a21\u5757\u7684\u300c\u521b\u5efa\u8ba2\u5355\u300d\u300c\u67e5\u8be2\u652f\u4ed8\u7ed3\u679c\u300d\uff09\uff0c\u4e0d\u5305\u542b\u6a21\u5757\u5185\u90e8\u7684\u8f85\u52a9\u903b\u8f91\uff1b<\/li>\n<li><strong>\u8f93\u5165\u8f93\u51fa\u660e\u786e<\/strong>\uff1a\u53c2\u6570\u548c\u8fd4\u56de\u503c\u4f18\u5148\u4f7f\u7528\u53ef\u5e8f\u5217\u5316\u3001\u7a33\u5b9a\u7684\u7c7b\u578b\uff08\u5982\u57fa\u672c\u7c7b\u578b\u3001Parcelable \u6570\u636e\u7c7b\u3001\u81ea\u5b9a\u4e49 DTO\uff09\uff0c\u907f\u514d\u4f7f\u7528\u7b2c\u4e09\u65b9\u6846\u67b6\u4f9d\u8d56\u7c7b\u578b\uff08\u5982 Retrofit \u7684 Call\uff09\uff1b<\/li>\n<li><strong>\u5f02\u5e38\u53ef\u9884\u671f<\/strong>\uff1a\u660e\u786e\u58f0\u660e\u53ef\u80fd\u629b\u51fa\u7684checked\u5f02\u5e38\uff08Java\uff09\u6216\u901a\u8fc7 Result \u5c01\u88c5\u5f02\u5e38\uff08Kotlin\uff09\uff0c\u4e0d\u9690\u85cf\u5d29\u6e83\u98ce\u9669\u3002<\/li>\n<\/ul>\n<h3>3. \u5de5\u7a0b\u5c42\u9762\u7684\u7279\u5f81<\/h3>\n<ul>\n<li>\u6a21\u5757\u7684 <code>build.gradle<\/code> \u4e2d\uff0c\u5bf9\u5916\u63d0\u4f9b\u7684\u4f9d\u8d56\u4ec5\u5305\u542b\u516c\u5f00 API \u6240\u9700\u7684\u300c\u6700\u5c0f\u4f9d\u8d56\u96c6\u300d\uff08\u907f\u514d\u4f20\u9012\u65e0\u5173\u4f9d\u8d56\uff09\uff1b<\/li>\n<li>\u516c\u5f00 API \u7684\u6587\u6863\uff08JavaDoc\/KDoc\uff09\u5b8c\u6574\uff0c\u5305\u542b\u53c2\u6570\u8bf4\u660e\u3001\u8fd4\u56de\u503c\u542b\u4e49\u3001\u4f7f\u7528\u793a\u4f8b\u3001\u517c\u5bb9\u7248\u672c\u7b49\uff1b<\/li>\n<li>\u975e\u516c\u5f00\u4ee3\u7801\u4e0d\u4f1a\u88ab\u5176\u4ed6\u6a21\u5757\u901a\u8fc7\u300c\u53cd\u5c04\u300d\u300c\u8de8\u5305\u8bbf\u95ee\u300d\u7b49\u65b9\u5f0f\u95f4\u63a5\u4f9d\u8d56\uff08\u9700\u901a\u8fc7 lint \u7b49\u5de5\u5177\u7981\u6b62\uff09\u3002<\/li>\n<\/ul>\n<h2>\u4e8c\u3001\u516c\u5f00 API \u53d8\u66f4\u7ba1\u63a7\u6d41\u7a0b<\/h2>\n<p>API \u53d8\u66f4\u7684\u6838\u5fc3\u539f\u5219\u662f\uff1a<strong>\u6700\u5c0f\u5316\u5f71\u54cd\u8303\u56f4\uff0c\u660e\u786e\u544a\u77e5\u4f9d\u8d56\u65b9\uff0c\u786e\u4fdd\u5411\u540e\u517c\u5bb9<\/strong>\u3002\u7ba1\u63a7\u6d41\u7a0b\u5206\u4e3a\u300c\u53d8\u66f4\u5206\u7c7b\u300d\u300c\u53d8\u66f4\u5ba1\u6279\u300d\u300c\u5b9e\u65bd\u4e0e\u53d1\u5e03\u300d\u300c\u517c\u5bb9\u4fdd\u969c\u300d\u56db\u6b65\uff1a<\/p>\n<h3>1. \u7b2c\u4e00\u6b65\uff1a\u660e\u786e\u53d8\u66f4\u7c7b\u578b\uff08\u51b3\u5b9a\u7ba1\u63a7\u4e25\u683c\u7a0b\u5ea6\uff09<\/h3>\n<p>\u6839\u636e\u5bf9\u4f9d\u8d56\u65b9\u7684\u5f71\u54cd\uff0c\u5c06\u53d8\u66f4\u5206\u4e3a 3 \u7c7b\uff0c\u7ba1\u63a7\u529b\u5ea6\u4f9d\u6b21\u9012\u589e\uff1a<\/p>\n<table>\n<thead>\n<tr>\n<th>\u53d8\u66f4\u7c7b\u578b<\/th>\n<th>\u5b9a\u4e49<\/th>\n<th>\u793a\u4f8b<\/th>\n<th>\u7ba1\u63a7\u8981\u6c42<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>\u517c\u5bb9\u53d8\u66f4\uff08Safe\uff09<\/td>\n<td>\u4e0d\u5f71\u54cd\u73b0\u6709\u8c03\u7528\uff0c\u4ec5\u65b0\u589e\u80fd\u529b\u6216\u4f18\u5316\u5b9e\u73b0<\/td>\n<td>1. \u65b0\u589e\u516c\u5f00\u65b9\u6cd5\/\u7c7b\uff1b2. \u7ed9\u73b0\u6709\u65b9\u6cd5\u65b0\u589e\u53ef\u9009\u53c2\u6570\uff1b3. \u4f18\u5316\u65b9\u6cd5\u5185\u90e8\u903b\u8f91\uff08\u4e0d\u6539\u53d8\u8f93\u5165\u8f93\u51fa\uff09<\/td>\n<td>\u65e0\u9700\u5ba1\u6279\uff0c\u76f4\u63a5\u53d1\u5e03\uff0c\u66f4\u65b0\u6587\u6863<\/td>\n<\/tr>\n<tr>\n<td>\u517c\u5bb9\u8b66\u544a\u53d8\u66f4\uff08Compatible with Warning\uff09<\/td>\n<td>\u73b0\u6709\u8c03\u7528\u4ecd\u53ef\u7528\uff0c\u4f46\u4e0d\u63a8\u8350\uff08\u672a\u6765\u53ef\u80fd\u79fb\u9664\uff09<\/td>\n<td>1. \u6807\u8bb0\u65b9\u6cd5\u4e3a <code>@Deprecated<\/code>\uff1b2. \u65b0\u589e\u66ff\u4ee3\u65b9\u6cd5<\/td>\n<td>\u9700\u540c\u6b65\u6587\u6863\u8bf4\u660e\u66ff\u4ee3\u65b9\u6848\uff0c\u9884\u7559\u81f3\u5c11 1 \u4e2a\u7248\u672c\u7684\u8fc7\u6e21\u671f<\/td>\n<\/tr>\n<tr>\n<td>\u4e0d\u517c\u5bb9\u53d8\u66f4\uff08Breaking Change\uff09<\/td>\n<td>\u73b0\u6709\u8c03\u7528\u4f1a\u5931\u6548\uff08\u7f16\u8bd1\u62a5\u9519\u3001\u8fd0\u884c\u5d29\u6e83\uff09<\/td>\n<td>1. \u5220\u9664\u516c\u5f00\u65b9\u6cd5\/\u7c7b\uff1b2. \u4fee\u6539\u65b9\u6cd5\u53c2\u6570\/\u8fd4\u56de\u503c\u7c7b\u578b\uff1b3. \u53d8\u66f4\u5f02\u5e38\u629b\u51fa\u89c4\u5219\uff1b4. \u964d\u4f4e\u8bbf\u95ee\u4fee\u9970\u7b26\uff08public \u2192 protected\uff09<\/td>\n<td>\u9700\u4e25\u683c\u5ba1\u6279\uff0c\u4ec5\u5141\u8bb8\u5728\u300c\u4e3b\u7248\u672c\u5347\u7ea7\u300d\uff08\u5982 1.x \u2192 2.x\uff09\u65f6\u8fdb\u884c\uff0c\u4e14\u5fc5\u987b\u63d0\u524d\u544a\u77e5\u6240\u6709\u4f9d\u8d56\u65b9<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3>2. \u7b2c\u4e8c\u6b65\uff1a\u53d8\u66f4\u5ba1\u6279\u4e0e\u51c6\u5907<\/h3>\n<ol>\n<li><strong>\u4f9d\u8d56\u5f71\u54cd\u8bc4\u4f30<\/strong>\uff1a\u901a\u8fc7\u5de5\u5177\uff08\u5982 Android Studio \u7684\u300cFind Usages\u300d\u3001\u81ea\u5b9a\u4e49 Gradle \u63d2\u4ef6\uff09\u626b\u63cf\u6240\u6709\u4f9d\u8d56\u8be5\u6a21\u5757\u7684\u9879\u76ee\uff0c\u660e\u786e\u53d7\u5f71\u54cd\u7684\u4ee3\u7801\u8303\u56f4\uff1b<\/li>\n<li><strong>\u53d8\u66f4\u65b9\u6848\u8bc4\u5ba1<\/strong>\uff1a\u63d0\u4ea4\u53d8\u66f4\u7533\u8bf7\uff08\u542b\u53d8\u66f4\u7c7b\u578b\u3001\u5f71\u54cd\u8303\u56f4\u3001\u517c\u5bb9\u63aa\u65bd\u3001\u66ff\u4ee3\u65b9\u6848\uff09\uff0c\u7531\u6a21\u5757\u8d1f\u8d23\u4eba\u3001\u4f9d\u8d56\u65b9\u8d1f\u8d23\u4eba\u5171\u540c\u8bc4\u5ba1\uff1b<\/li>\n<li><strong>\u6587\u6863\u51c6\u5907<\/strong>\uff1a\u66f4\u65b0 API \u6587\u6863\uff08\u5982 Dokka \u751f\u6210\u7684\u6587\u6863\u3001Wiki\uff09\uff0c\u660e\u786e\u6807\u6ce8\u53d8\u66f4\u70b9\u3001\u517c\u5bb9\u7248\u672c\u3001\u8fc1\u79fb\u6307\u5357\uff1b<\/li>\n<li><strong>\u6d4b\u8bd5\u51c6\u5907<\/strong>\uff1a\u8865\u5145\u56de\u5f52\u6d4b\u8bd5\u7528\u4f8b\uff08\u8986\u76d6\u65e7 API \u517c\u5bb9\u573a\u666f\u3001\u65b0 API \u529f\u80fd\u573a\u666f\uff09\uff0c\u786e\u4fdd\u65e0\u9057\u6f0f\u3002<\/li>\n<\/ol>\n<h3>3. \u7b2c\u4e09\u6b65\uff1a\u53d8\u66f4\u5b9e\u65bd\u4e0e\u53d1\u5e03<\/h3>\n<h4>\uff081\uff09\u517c\u5bb9\u53d8\u66f4\u5b9e\u65bd<\/h4>\n<ul>\n<li>\u65b0\u589e API \u65f6\uff0c\u9075\u5faa\u300c\u63a5\u53e3\u4f18\u5148\u300d\u539f\u5219\uff1a\u4f18\u5148\u5b9a\u4e49\u63a5\u53e3\uff08\u5982 <code>PayApi<\/code>\uff09\uff0c\u518d\u63d0\u4f9b\u5b9e\u73b0\u7c7b\uff08\u5982 <code>PayApiImpl<\/code>\uff09\uff0c\u4fbf\u4e8e\u540e\u7eed\u6269\u5c55\uff1b<\/li>\n<li>\u65b0\u589e\u53c2\u6570\u65f6\uff0c\u5fc5\u987b\u8bbe\u4e3a\u300c\u53ef\u9009\u53c2\u6570\u300d\uff08Kotlin\uff1a<code>fun createOrder(amount: Int, discount: Int = 0)<\/code>\uff1bJava\uff1a\u63d0\u4f9b\u91cd\u8f7d\u65b9\u6cd5 <code>createOrder(int amount)<\/code> \u548c <code>createOrder(int amount, int discount)<\/code>\uff09\u3002<\/li>\n<\/ul>\n<h4>\uff082\uff09\u4e0d\u517c\u5bb9\u53d8\u66f4\u5b9e\u65bd<\/h4>\n<ul>\n<li>\u91c7\u7528\u300c\u6e10\u8fdb\u5f0f\u8fc1\u79fb\u300d\u7b56\u7565\uff1a\n<ol>\n<li>\u7b2c\u4e00\u9636\u6bb5\uff1a\u6807\u8bb0\u65e7 API \u4e3a <code>@Deprecated<\/code>\uff0c\u63d0\u4f9b\u65b0 API \u66ff\u4ee3\uff0c\u65e7 API \u5185\u90e8\u8f6c\u53d1\u5230\u65b0 API \u5b9e\u73b0\uff08\u4fdd\u8bc1\u517c\u5bb9\uff09\uff1b<\/li>\n<li>\u7b2c\u4e8c\u9636\u6bb5\uff1a\u4fdd\u7559\u65e7 API\uff0c\u4f46\u5728\u6587\u6863\u4e2d\u660e\u786e\u544a\u77e5\u300c\u4e0b\u4e00\u4e2a\u4e3b\u7248\u672c\u5c06\u79fb\u9664\u300d\uff0c\u5e76\u5728\u65e5\u5fd7\u4e2d\u6253\u5370\u8b66\u544a\uff1b<\/li>\n<li>\u7b2c\u4e09\u9636\u6bb5\uff1a\u4e3b\u7248\u672c\u5347\u7ea7\u65f6\uff0c\u5220\u9664\u65e7 API\uff0c\u540c\u6b65\u66f4\u65b0\u6240\u6709\u4f9d\u8d56\u65b9\u4ee3\u7801\u3002<\/li>\n<\/ol>\n<\/li>\n<li>\n<p>\u793a\u4f8b\uff08Kotlin\uff09\uff1a<\/p>\n<pre><code class=\"language-kotlin\">\/\/ \u7b2c\u4e00\u9636\u6bb5\uff1a\u65b0\u589e\u65b0 API\uff0c\u65e7 API \u6807\u8bb0 Deprecated \u5e76\u8f6c\u53d1\n@PublicApi\nclass PayApi {\n  \/\/ \u65e7 API\uff08\u517c\u5bb9\u4e2d\uff09\n  @Deprecated(\"\u8bf7\u4f7f\u7528 createOrder(OrderParam)\uff0cv2.0 \u5c06\u79fb\u9664\", ReplaceWith(\"createOrder(OrderParam(amount))\"))\n  fun createOrder(amount: Int): String {\n      return createOrder(OrderParam(amount)) \/\/ \u5185\u90e8\u8f6c\u53d1\u5230\u65b0 API\n  }\n\n  \/\/ \u65b0 API\uff08\u63a8\u8350\u4f7f\u7528\uff09\n  @PublicApi\n  fun createOrder(param: OrderParam): String {\n      \/\/ \u65b0\u5b9e\u73b0\n  }\n}\n\n\/\/ \u7b2c\u4e09\u9636\u6bb5\uff08v2.0\uff09\uff1a\u5220\u9664\u65e7 API\uff0c\u4ec5\u4fdd\u7559\u65b0 API<\/code><\/pre>\n<\/li>\n<\/ul>\n<h4>\uff083\uff09\u53d1\u5e03\u89c4\u8303<\/h4>\n<ul>\n<li>\u7248\u672c\u53f7\u9075\u5faa <a href=\"https:\/\/semver.org\/\">Semantic Versioning\uff08\u8bed\u4e49\u5316\u7248\u672c\uff09<\/a>\uff1a<code>\u4e3b\u7248\u672c\u53f7.\u6b21\u7248\u672c\u53f7.\u4fee\u8ba2\u53f7<\/code>\n<ul>\n<li>\u517c\u5bb9\u53d8\u66f4\uff1a\u66f4\u65b0\u300c\u4fee\u8ba2\u53f7\u300d\uff08\u5982 1.0.0 \u2192 1.0.1\uff09\uff1b<\/li>\n<li>\u65b0\u589e API\uff08\u517c\u5bb9\uff09\uff1a\u66f4\u65b0\u300c\u6b21\u7248\u672c\u53f7\u300d\uff08\u5982 1.0.1 \u2192 1.1.0\uff09\uff1b<\/li>\n<li>\u4e0d\u517c\u5bb9\u53d8\u66f4\uff1a\u66f4\u65b0\u300c\u4e3b\u7248\u672c\u53f7\u300d\uff08\u5982 1.1.0 \u2192 2.0.0\uff09\uff1b<\/li>\n<\/ul>\n<\/li>\n<li>\u53d1\u5e03\u65f6\u9644\u5e26\u300c\u53d8\u66f4\u65e5\u5fd7\uff08Changelog\uff09\u300d\uff0c\u660e\u786e\u6807\u6ce8 API \u53d8\u66f4\u7c7b\u578b\u3001\u5f71\u54cd\u8303\u56f4\u3001\u8fc1\u79fb\u6307\u5357\u3002<\/li>\n<\/ul>\n<h3>4. \u7b2c\u56db\u6b65\uff1a\u517c\u5bb9\u4fdd\u969c\u4e0e\u95ee\u9898\u515c\u5e95<\/h3>\n<ul>\n<li><strong>\u7070\u5ea6\u53d1\u5e03<\/strong>\uff1a\u5148\u5411\u90e8\u5206\u4f9d\u8d56\u65b9\u7070\u5ea6\u53d1\u5e03\u53d8\u66f4\u540e\u7684\u6a21\u5757\uff0c\u6536\u96c6\u53cd\u9988\uff0c\u907f\u514d\u5168\u91cf\u53d1\u5e03\u5bfc\u81f4\u5927\u89c4\u6a21\u95ee\u9898\uff1b<\/li>\n<li><strong>\u56de\u6eda\u673a\u5236<\/strong>\uff1a\u82e5\u53d1\u73b0\u53d8\u66f4\u5f15\u5165\u4e25\u91cd\u517c\u5bb9\u95ee\u9898\uff0c\u7acb\u5373\u56de\u6eda\u5230\u4e0a\u4e00\u4e2a\u7a33\u5b9a\u7248\u672c\uff0c\u6682\u505c\u53d8\u66f4\uff1b<\/li>\n<li><strong>\u6280\u672f\u515c\u5e95<\/strong>\uff1a\u5bf9\u4e8e\u65e0\u6cd5\u907f\u514d\u7684\u4e0d\u517c\u5bb9\u53d8\u66f4\uff0c\u63d0\u4f9b\u300c\u9002\u914d\u5c42\u300d\uff08\u5982\u9002\u914d\u7c7b\u3001\u9759\u6001\u4ee3\u7406\uff09\uff0c\u5e2e\u52a9\u4f9d\u8d56\u65b9\u5feb\u901f\u8fc1\u79fb\uff08\u793a\u4f8b\u5982\u4e0b\uff09\uff1a\n<pre><code class=\"language-kotlin\">\/\/ \u9002\u914d\u5c42\uff1a\u517c\u5bb9\u65e7 API \u8c03\u7528\uff0c\u5185\u90e8\u8f6c\u6362\u4e3a\u65b0 API\nobject PayApiAdapter {\n  \/\/ \u65e7 API \u7b7e\u540d\uff0c\u4f9b\u672a\u8fc1\u79fb\u7684\u4f9d\u8d56\u65b9\u8c03\u7528\n  fun createOrder(amount: Int): String {\n      return PayApi().createOrder(OrderParam(amount))\n  }\n}<\/code><\/pre>\n<\/li>\n<\/ul>\n<h2>\u4e09\u3001\u843d\u5730\u5de5\u5177\u4e0e\u6700\u4f73\u5b9e\u8df5<\/h2>\n<h3>1. \u5de5\u5177\u9009\u578b\uff1a\u81ea\u52a8\u5316\u7ba1\u63a7 API \u53d8\u66f4<\/h3>\n<table>\n<thead>\n<tr>\n<th>\u5de5\u5177\u7528\u9014<\/th>\n<th>\u63a8\u8350\u5de5\u5177<\/th>\n<th>\u6838\u5fc3\u80fd\u529b<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>API \u8fb9\u754c\u5b9a\u4e49<\/td>\n<td>\u81ea\u5b9a\u4e49 <code>@PublicApi<\/code> \u6ce8\u89e3 + Lint \u89c4\u5219<\/td>\n<td>\u5f3a\u5236\u516c\u5f00 API \u5fc5\u987b\u52a0\u6ce8\u89e3\uff0c\u7981\u6b62\u5185\u90e8\u4ee3\u7801\u88ab\u5916\u90e8\u4f9d\u8d56<\/td>\n<\/tr>\n<tr>\n<td>API \u53d8\u66f4\u68c0\u6d4b<\/td>\n<td>1. <a href=\"https:\/\/kotlinlang.org\/docs\/dokka.html\">Dokka<\/a>\uff08\u751f\u6210 API \u6587\u6863\uff0c\u5bf9\u6bd4\u7248\u672c\u5dee\u5f02\uff09\uff1b2. <a href=\"https:\/\/github.com\/ben-manes\/gradle-versions-plugin\">Gradle API Check \u63d2\u4ef6<\/a>\uff1b3. <a href=\"https:\/\/github.com\/Kotlin\/binary-compatibility-validator\">Binary Compatibility Validator<\/a>\uff08Kotlin \u5b98\u65b9\u5de5\u5177\uff0c\u68c0\u6d4b\u4e8c\u8fdb\u5236\u517c\u5bb9\u6027\uff09<\/td>\n<td>\u81ea\u52a8\u8bc6\u522b\u4e0d\u517c\u5bb9\u53d8\u66f4\uff08\u5982\u65b9\u6cd5\u5220\u9664\u3001\u53c2\u6570\u53d8\u66f4\uff09\uff0c\u6784\u5efa\u65f6\u62a5\u9519<\/td>\n<\/tr>\n<tr>\n<td>\u4f9d\u8d56\u5f71\u54cd\u5206\u6790<\/td>\n<td>1. Android Studio\u300cFind Usages\u300d\uff1b2. <a href=\"https:\/\/github.com\/clarkware\/jdepend\">JDepend<\/a>\uff1b3. \u81ea\u5b9a\u4e49 Gradle \u63d2\u4ef6\u626b\u63cf\u9879\u76ee\u4f9d\u8d56<\/td>\n<td>\u5feb\u901f\u5b9a\u4f4d\u4f9d\u8d56\u8be5 API \u7684\u6240\u6709\u6a21\u5757\/\u4ee3\u7801<\/td>\n<\/tr>\n<tr>\n<td>\u6587\u6863\u751f\u6210<\/td>\n<td>Dokka\uff08Kotlin\uff09\u3001JavaDoc\uff08Java\uff09<\/td>\n<td>\u81ea\u52a8\u751f\u6210\u7ed3\u6784\u5316 API \u6587\u6863\uff0c\u5305\u542b\u53d8\u66f4\u5386\u53f2\u3001\u4f7f\u7528\u793a\u4f8b<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3>2. \u6700\u4f73\u5b9e\u8df5\uff1a\u907f\u514d API \u53d8\u66f4\u98ce\u9669<\/h3>\n<h4>\uff081\uff09API \u8bbe\u8ba1\u9636\u6bb5\uff1a\u4ece\u6e90\u5934\u51cf\u5c11\u53d8\u66f4<\/h4>\n<ul>\n<li>\n<p>\u4f18\u5148\u4f7f\u7528\u300c\u63a5\u53e3 + \u5de5\u5382\u6a21\u5f0f\u300d\u66b4\u9732 API\uff0c\u907f\u514d\u76f4\u63a5\u66b4\u9732\u5b9e\u73b0\u7c7b\uff08\u4fbf\u4e8e\u540e\u7eed\u66ff\u6362\u5b9e\u73b0\uff0c\u4e0d\u5f71\u54cd\u8c03\u7528\u65b9\uff09\uff1a<\/p>\n<pre><code class=\"language-kotlin\">\/\/ \u63a8\u8350\uff1a\u66b4\u9732\u63a5\u53e3 + \u5de5\u5382\u65b9\u6cd5\n@PublicApi\ninterface PayApi {\n  fun createOrder(param: OrderParam): String\n\n  companion object Factory {\n      fun getInstance(): PayApi = PayApiImpl() \/\/ \u9690\u85cf\u5b9e\u73b0\u7c7b\n  }\n}\n\n\/\/ \u4e0d\u63a8\u8350\uff1a\u76f4\u63a5\u66b4\u9732\u5b9e\u73b0\u7c7b\n@PublicApi\nclass PayApiImpl { ... } \/\/ \u540e\u7eed\u4fee\u6539\u7c7b\u540d\/\u7ed3\u6784\u4f1a\u5bfc\u81f4\u4e0d\u517c\u5bb9<\/code><\/pre>\n<\/li>\n<li>\n<p>\u7528\u300c\u6570\u636e\u7c7b\/DTO\u300d\u5c01\u88c5\u590d\u6742\u53c2\u6570\uff08\u907f\u514d\u540e\u7eed\u65b0\u589e\u53c2\u6570\u65f6\u4fee\u6539\u65b9\u6cd5\u7b7e\u540d\uff09\uff1a<\/p>\n<pre><code class=\"language-kotlin\">\/\/ \u63a8\u8350\uff1a\u7528 DTO \u5c01\u88c5\u53c2\u6570\n@PublicApi\ndata class OrderParam(\n  val amount: Int,\n  val discount: Int = 0, \/\/ \u65b0\u589e\u53c2\u6570\u65f6\u8bbe\u4e3a\u53ef\u9009\uff0c\u517c\u5bb9\u65e7\u8c03\u7528\n  val remark: String? = null\n)\n\n\/\/ \u4e0d\u63a8\u8350\uff1a\u53c2\u6570\u76f4\u63a5\u5199\u5728\u65b9\u6cd5\u4e0a\uff08\u65b0\u589e\u53c2\u6570\u9700\u6539\u7b7e\u540d\uff09\nfun createOrder(amount: Int, discount: Int, remark: String) { ... }<\/code><\/pre>\n<\/li>\n<li>\n<p>\u907f\u514d\u66b4\u9732\u300c\u53ef\u53d8\u72b6\u6001\u300d\uff1a\u516c\u5f00 API \u7684\u8fd4\u56de\u503c\u4f18\u5148\u7528\u4e0d\u53ef\u53d8\u7c7b\u578b\uff08\u5982 Kotlin <code>val<\/code>\u3001Java <code>final<\/code>\uff09\uff0c\u7981\u6b62\u8fd4\u56de\u5185\u90e8\u96c6\u5408\u7684\u5f15\u7528\uff08\u907f\u514d\u5916\u90e8\u4fee\u6539\u5bfc\u81f4\u6570\u636e\u9519\u4e71\uff09\uff1a<\/p>\n<pre><code class=\"language-kotlin\">\/\/ \u63a8\u8350\uff1a\u8fd4\u56de\u4e0d\u53ef\u53d8\u96c6\u5408\nfun getOrderList(): List<Order> = orderList.toList() \/\/ \u62f7\u8d1d\u4e00\u4efd\uff0c\u907f\u514d\u5916\u90e8\u4fee\u6539\n\n\/\/ \u4e0d\u63a8\u8350\uff1a\u8fd4\u56de\u53ef\u53d8\u96c6\u5408\nfun getOrderList(): MutableList<Order> = orderList \/\/ \u5916\u90e8\u53ef\u4fee\u6539\u5185\u90e8\u72b6\u6001<\/code><\/pre>\n<\/li>\n<\/ul>\n<h4>\uff082\uff09\u5de5\u7a0b\u89c4\u8303\uff1a\u5f3a\u5236 API \u7ba1\u63a7<\/h4>\n<ul>\n<li>\u6a21\u5757\u5305\u7ed3\u6784\u5f3a\u5236\u5206\u79bb\u300c\u516c\u5f00 API\u300d\u548c\u300c\u5185\u90e8\u5b9e\u73b0\u300d\uff1a\n<pre><code>com.xxx.module\n\u251c\u2500\u2500 api\/          \/\/ \u516c\u5f00 API\uff08\u4ec5\u653e interface\u3001DTO\u3001\u5de5\u5177\u7c7b\uff09\n\u2502   \u251c\u2500\u2500 PayApi.kt\n\u2502   \u2514\u2500\u2500 OrderParam.kt\n\u251c\u2500\u2500 internal\/     \/\/ \u5185\u90e8\u5b9e\u73b0\uff08\u7981\u6b62\u5916\u90e8\u4f9d\u8d56\uff09\n\u2502   \u251c\u2500\u2500 PayApiImpl.kt\n\u2502   \u2514\u2500\u2500 utils\/\n\u2514\u2500\u2500 BuildConfig.kt<\/code><\/pre>\n<\/li>\n<li>\u7528 Lint \u89c4\u5219\u7981\u6b62\u300c\u5185\u90e8\u4ee3\u7801\u88ab\u516c\u5f00\u4f9d\u8d56\u300d\uff1a\u81ea\u5b9a\u4e49 Lint \u68c0\u67e5\uff0c\u82e5\u5176\u4ed6\u6a21\u5757\u5f15\u7528\u4e86 <code>internal<\/code> \u5305\u4e0b\u7684\u7c7b\uff0c\u76f4\u63a5\u7f16\u8bd1\u62a5\u9519\uff1b<\/li>\n<li>\u5b9a\u671f\u5ba1\u8ba1 API\uff1a\u6bcf\u5b63\u5ea6review\u516c\u5f00 API\uff0c\u6e05\u7406\u5e9f\u5f03\u63a5\u53e3\uff08Deprecated \u8d85\u8fc7 2 \u4e2a\u7248\u672c\u7684\uff09\uff0c\u907f\u514d API \u81a8\u80c0\u3002<\/li>\n<\/ul>\n<h4>\uff083\uff09\u6c9f\u901a\u673a\u5236\uff1a\u786e\u4fdd\u4f9d\u8d56\u65b9\u540c\u6b65<\/h4>\n<ul>\n<li>\u5efa\u7acb API \u53d8\u66f4\u901a\u77e5\u673a\u5236\uff1a\u901a\u8fc7\u56e2\u961f\u7fa4\u3001Wiki \u516c\u544a\u3001\u7248\u672c\u65e5\u5fd7\u7b49\u65b9\u5f0f\uff0c\u63d0\u524d\u544a\u77e5\u4f9d\u8d56\u65b9\u53d8\u66f4\u8ba1\u5212\uff1b<\/li>\n<li>\u63d0\u4f9b\u8fc1\u79fb\u652f\u6301\uff1a\u9488\u5bf9\u4e0d\u517c\u5bb9\u53d8\u66f4\uff0c\u7f16\u5199\u8fc1\u79fb\u6587\u6863\u3001\u793a\u4f8b\u4ee3\u7801\uff0c\u751a\u81f3\u63d0\u4f9b\u4e34\u65f6\u9002\u914d\u5c42\uff0c\u964d\u4f4e\u4f9d\u8d56\u65b9\u8fc1\u79fb\u6210\u672c\u3002<\/li>\n<\/ul>\n<h2>\u603b\u7ed3<\/h2>\n<p>Android \u6a21\u5757\u516c\u5f00 API \u7684\u6838\u5fc3\u7279\u5f81\u662f\u300c\u516c\u5f00\u8bbf\u95ee\u3001\u7a33\u5b9a\u5951\u7ea6\u3001\u96c6\u4e2d\u66b4\u9732\u300d\uff0c\u5176\u53d8\u66f4\u7ba1\u63a7\u7684\u6838\u5fc3\u662f\u300c\u533a\u5206\u53d8\u66f4\u7c7b\u578b\u3001\u6700\u5c0f\u5316\u5f71\u54cd\u3001\u4fdd\u969c\u5411\u540e\u517c\u5bb9\u300d\u3002\u901a\u8fc7\u300c\u89c4\u8303 API \u8bbe\u8ba1 + \u81ea\u52a8\u5316\u5de5\u5177\u68c0\u6d4b + \u6e10\u8fdb\u5f0f\u53d8\u66f4 + \u5145\u5206\u6c9f\u901a\u300d\uff0c\u53ef\u6709\u6548\u964d\u4f4e API \u53d8\u66f4\u5e26\u6765\u7684\u98ce\u9669\uff0c\u786e\u4fdd\u8de8\u6a21\u5757\u4f9d\u8d56\u7684\u7a33\u5b9a\u6027\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Android \u6a21\u5757\u516c\u5f00 API \u7684\u7279\u5f81\u4e0e\u53d8\u66f4\u7ba1\u63a7\u65b9\u6848 \u5728 Android \u5f00\u53d1\u4e2d\uff0c\u6a21\u5757\uff08\u5982 Library &#8230; <\/p>\n<div class=\"read-more navbutton\"><a href=\"https:\/\/t.n-years.com\/?p=6930\">\u9605\u8bfb\u66f4\u591a<i class=\"fa fa-angle-double-right\"><\/i><\/a><\/div>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[135],"tags":[],"class_list":["post-6930","post","type-post","status-publish","format-standard","hentry","category-135"],"_links":{"self":[{"href":"https:\/\/t.n-years.com\/index.php?rest_route=\/wp\/v2\/posts\/6930","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/t.n-years.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/t.n-years.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/t.n-years.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/t.n-years.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=6930"}],"version-history":[{"count":1,"href":"https:\/\/t.n-years.com\/index.php?rest_route=\/wp\/v2\/posts\/6930\/revisions"}],"predecessor-version":[{"id":6931,"href":"https:\/\/t.n-years.com\/index.php?rest_route=\/wp\/v2\/posts\/6930\/revisions\/6931"}],"wp:attachment":[{"href":"https:\/\/t.n-years.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=6930"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/t.n-years.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=6930"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/t.n-years.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=6930"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}