wecom sdk

?如果你感覺這個項目不錯，請點擊項目右上角的以鼓勵作者，謝謝?。

須知

1. 程式碼完全開源，使用前請認真嘗試範例工程
2. 在嘗試步驟1的前提下遇到問題經過一系列努力無法解決，請提issue，或透過自行擴充程式碼解決

?簡介

wecom-sdk是開源的企業微信開放API 的Java 實現，是目前最完整的Java 開源實作。經過近三年的迭代，目前已經實現了通訊錄管理、客戶管理、微信客服、素材管理、訊息推送、企微機器人、身份驗證、應用管理、OA 辦公、企業支付等企業微信開放接口，開發人員不需要很高的學習成本就能快速優雅地連結企業微信。

?企微機器人範例

 /**
 * 企微机器人
 *
 * @throws IOException the io exception
 */
@ Test
void webHooks () throws IOException {
        // 发 markdown
        WebhookBody markdownBody = WebhookMarkdownBody . from ( "这里为markdown消息" );
        // 发纯文本
        WebhookBody textBody = WebhookTextBody . from ( "这里为纯文本" );
        // 发图文
        WebhookArticle article = new WebhookArticle ( "这里为标题" , "这里为图文链接" )
                                   . picurl ( "这里为封面图链接" )
                                   . description ( "这里为摘要信息" );
        WebhookBody newsBody = WebhookNewsBody . from ( Collections . singletonList ( article ));
        // 从base64发图片
        String base64 = "图片base64" ;
        String md5 = "图片base64的md5" ;
        WebhookBody imageBody1 = WebhookImageBody . from ( base64 , md5 );
        // 从流发送图片
        String path = "C: \ Users \ Administrator \ Desktop \ 0.png" ;
        InputStream inputStream = Files . newInputStream ( Paths . get ( path ));
        WebhookBody imageBody2 = WebhookImageBody . from ( inputStream );
        WeComResponse weComResponse = WorkWeChatApi . webhookApi (). send ( "机器人key" , markdownBody );
        Assertions . assertTrue ( weComResponse . isSuccessful ());
        
}

更多範例請參考SpringBootWecomSdkTests.java

特性

• 支援多個企業微信同時配置作業
• 整合方便，適用於各種Java 生態
• 目前實現企業微信介面200多個，能滿足大部分場景的需求
• 全參數封裝，參數高度語意化封裝，再也不擔心組織參數、解析參數的問題
• 實現統一回調，所有回呼事件可集中非同步處理，開發者只需要關心業務邏輯的處理
• 統一異常處理，企業微信API呼叫異常統一由WeComException管理
• 由SDK 接手Token 生命週期，開發者無需關心Token 的管理。

目前自建應用可輕鬆適配，服務商、代開發暫不開源。

✍️技術棧

• Retrofit2，支援最高版本號2.11.0
• OkHttp4，支援最高版本號4.12.0
• Rxjava3，支援最高版本號3.1.8
• Jackson2，支援最高版本號2.15.2
• XStream，支援最高版本號1.4.20

?️Maven中央倉庫座標

• 普通版本

< dependency >
    < groupId >cn.felord</ groupId >
    < artifactId >wecom-sdk</ artifactId >
    < version >1.3.2</ version >
</ dependency >

• rxjava 版本

< dependency >
    < groupId >cn.felord</ groupId >
    < artifactId >rx-wecom-sdk</ artifactId >
    < version >1.3.2</ version >
</ dependency >

• 如何查找想要的API?

由於實現的太全了，想要準確找到API，你可以這樣：

 public interface TagApi {

    /**
     * 创建标签
     *
     * @param request the request
     * @return GenericResponse generic response
     * @throws WeComException the weComException
     */
    @ POST ( "tag/create" )
    GenericResponse < String > createTag ( @ Body Tag request ) throws WeComException ;
}    

先到企業微信API文件找到你需要的API，例如建立標籤https://qyapi.weixin.qq.com/cgi-bin/tag/create?access_token=ACCESS_TOKEN ，截取tag/create全域搜尋即可。

• Okhttp低版本相容依賴

會報錯NoSuchMethod的是因為你專案本身引入了Okhttp，但是版本比較低，導致不相容的情況，可透過以下依賴引入wecom-sdk

< dependency >
    < groupId >cn.felord</ groupId >
    < artifactId >wecom-sdk</ artifactId >
    < version >1.3.2</ version >
    < exclusions >
        < exclusion >
            < groupId >com.squareup.okhttp3</ groupId >
            < artifactId >okhttp</ artifactId >
        </ exclusion >
        < exclusion >
            < groupId >com.squareup.okhttp3</ groupId >
            < artifactId >logging-interceptor</ artifactId >
        </ exclusion >
    </ exclusions >
</ dependency >

< dependency >
    < groupId >com.squareup.okhttp3</ groupId >
    < artifactId >okhttp</ artifactId >
    < version >4.12.0</ version >
</ dependency >

< dependency >
    < groupId >com.squareup.okhttp3</ groupId >
    < artifactId >logging-interceptor</ artifactId >
    < version >4.12.0</ version >
</ dependency >

文件

不再提供任何文檔，程式碼即文檔

?特別鳴謝