├── .github ├── CODEOWNERS └── workflows │ └── maven.yml ├── .gitignore ├── .gitpod.Dockerfile ├── .gitpod.yml ├── .vscode └── settings.json ├── LICENSE ├── Makefile ├── NOTICE ├── README.md ├── VERSION └── examples ├── ding-dong-bot.kt ├── dong-dong-bot.java ├── pom.xml └── src └── main ├── java └── io │ └── github │ └── wechaty │ └── DingDongBot.java ├── kotlin └── io │ └── github │ └── wechaty │ └── ding-dong-bot.kt └── resources └── log4j2.xml /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # 2 | # https://help.github.com/articles/about-codeowners/ 3 | # 4 | 5 | * @wechaty/java 6 | -------------------------------------------------------------------------------- /.github/workflows/maven.yml: -------------------------------------------------------------------------------- 1 | # This workflow will build a Java project with Maven 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven 3 | 4 | name: Java CI with Maven 5 | 6 | on: 7 | push: 8 | branches: [ master ] 9 | pull_request: 10 | branches: [ master ] 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - uses: actions/checkout@v2 19 | - name: Set up JDK 1.8 20 | uses: actions/setup-java@v1 21 | with: 22 | java-version: 1.8 23 | - name: Build with Maven 24 | run: mvn -B package --file examples/pom.xml 25 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled class file 2 | *.class 3 | 4 | # Log file 5 | *.log 6 | 7 | # BlueJ files 8 | *.ctxt 9 | 10 | # Mobile Tools for Java (J2ME) 11 | .mtj.tmp/ 12 | 13 | # Package Files # 14 | *.jar 15 | *.war 16 | *.nar 17 | *.ear 18 | *.zip 19 | *.tar.gz 20 | *.rar 21 | 22 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 23 | hs_err_pid* 24 | 25 | .idea 26 | *.iml 27 | target/ 28 | 29 | examples/.classpath 30 | examples/.project 31 | examples/.settings/ 32 | -------------------------------------------------------------------------------- /.gitpod.Dockerfile: -------------------------------------------------------------------------------- 1 | FROM gitpod/workspace-full 2 | 3 | USER gitpod 4 | 5 | # Install custom tools, runtime, etc. using apt-get 6 | # For example, the command below would install "bastet" - a command line tetris clone: 7 | # 8 | # RUN sudo apt-get -q update && # sudo apt-get install -yq bastet && # sudo rm -rf /var/lib/apt/lists/* 9 | # 10 | # More information: https://www.gitpod.io/docs/config-docker/ 11 | -------------------------------------------------------------------------------- /.gitpod.yml: -------------------------------------------------------------------------------- 1 | tasks: 2 | - init: make 3 | image: 4 | file: .gitpod.Dockerfile 5 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "files.exclude": { 3 | "**/.classpath": true, 4 | "**/.project": true, 5 | "**/.settings": true, 6 | "**/.factorypath": true 7 | } 8 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2020-now Wechaty 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: all 2 | all: install bot 3 | 4 | .PHONY: install 5 | install: 6 | mvn clean install -f examples/pom.xml 7 | 8 | .PHONY: bot 9 | bot: 10 | java -jar examples/target/wechaty-examples-1.0.0-SNAPSHOT-jar-with-dependencies.jar 11 | 12 | .PHONY: clean 13 | clean: 14 | rm -fr examples/target/* 15 | 16 | .PHONY: version 17 | version: 18 | @newVersion=$$(awk -F. '{print $$1"."$$2"."$$3+1}' < VERSION) \ 19 | && echo $${newVersion} > VERSION \ 20 | && git add VERSION \ 21 | && git commit -m "$${newVersion}" > /dev/null \ 22 | && git tag "v$${newVersion}" \ 23 | && echo "Bumped version to $${newVersion}" 24 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | Java Wechaty Chatbot SDK 2 | Copyright 2020 Wechaty Contributors. 3 | 4 | This product includes software developed at 5 | The Wechaty Organization (https://github.com/wechaty). 6 | 7 | This software contains code derived from the Stackoverflow, 8 | including various modifications by GitHub. 9 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # java-wechaty-getting-started [![Java Version](https://img.shields.io/maven-central/v/io.github.wechaty/wechaty?label=Java)](https://mvnrepository.com/artifact/io.github.wechaty/wechaty) [![Java CI with Maven](https://github.com/wechaty/java-wechaty-getting-started/workflows/Java%20CI%20with%20Maven/badge.svg)](https://github.com/wechaty/java-wechaty-getting-started/actions?query=workflow%3A%22Java+CI+with+Maven%22) 2 | 3 | [![Java Wechaty](https://wechaty.github.io/java-wechaty/images/java-wechaty.png)](https://github.com/wechaty/java-wechaty-getting-started) 4 | 5 | Java Wechaty Starter Project Template that Works Out-of-the-Box 6 | 7 | [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/wechaty/java-wechaty-getting-started) 8 | [![Wechaty in Java](https://img.shields.io/badge/Wechaty-Java-blue)](https://github.com/wechaty/java-wechaty) 9 | 10 | ## Connecting Chatbots 11 | 12 | [![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-brightgreen.svg)](https://github.com/Wechaty/wechaty) 13 | [![Java Version](https://img.shields.io/maven-central/v/io.github.wechaty/wechaty?label=Java)](https://mvnrepository.com/artifact/io.github.wechaty/wechaty) 14 | 15 | Wechaty is a RPA SDK for Wechat **Individual** Account that can help you create a chatbot in 6 lines of Java. 16 | 17 | ## The World's Shortest Java ChatBot: 6 lines of Code 18 | 19 | ```java 20 | class Bot{ 21 | public static void main(String args[]){ 22 | Wechaty bot = Wechaty.instance() 23 | .onScan((qrcode, statusScanStatus, data) -> System.out.println(QrcodeUtils.getQr(qrcode))) 24 | .onLogin(user -> System.out.println("User logined :" + user)) 25 | .onMessage(message -> System.out.println("Message:" + message)) 26 | .start(true); 27 | } 28 | } 29 | ``` 30 | 31 | ## Usage 32 | 33 | ### Install 34 | 35 | ```sh 36 | # Install Maven 37 | apt install maven 38 | 39 | make install 40 | ``` 41 | 42 | ### Run 43 | 44 | ```sh 45 | export WECHATY_PUPPET_SERVICE_TOKEN=your_token_at_here 46 | 47 | make bot 48 | ``` 49 | 50 | ## Wechaty Getting Started in Multiple Languages 51 | 52 | - [TypeScript Wechaty Getting Started](https://github.com/wechaty/wechaty-getting-started) 53 | - [Python Wechaty Getting Started](https://github.com/wechaty/python-wechaty-getting-started) 54 | - [Java Wechaty Getting Started](https://github.com/wechaty/java-wechaty-getting-started) 55 | - [Go Wechaty Getting Started](https://github.com/wechaty/go-wechaty-getting-started) 56 | 57 | ## Badge 58 | 59 | [![Wechaty in Java](https://img.shields.io/badge/Wechaty-Java-blue)](https://github.com/wechaty/java-wechaty) 60 | 61 | ```md 62 | [![Wechaty in Java](https://img.shields.io/badge/Wechaty-Java-blue)](https://github.com/wechaty/java-wechaty) 63 | ``` 64 | 65 | ## Maintainers 66 | 67 | [@wechaty/java](https://github.com/orgs/wechaty/teams/java/members) 68 | 69 | ## Copyright & License 70 | 71 | - Code & Docs © 2020 Wechaty Contributors 72 | - Code released under the Apache-2.0 License 73 | - Docs released under Creative Commons 74 | -------------------------------------------------------------------------------- /VERSION: -------------------------------------------------------------------------------- 1 | 0.0.3 2 | -------------------------------------------------------------------------------- /examples/ding-dong-bot.kt: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is a helper file to point to the DingDongBot.kt source code at: 3 | * src/main/kotlin/io/github/wechaty/DingDongBot.kt 4 | */ -------------------------------------------------------------------------------- /examples/dong-dong-bot.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is a helper file to point to the DingDongBot.java source code at: 3 | * src/main/java/io/github/wechaty/DingDongBot.java 4 | */ 5 | -------------------------------------------------------------------------------- /examples/pom.xml: -------------------------------------------------------------------------------- 1 | 3 | 4 | 5 | io.github.wechaty 6 | 4.0.0 7 | wechaty-examples 8 | wechaty-examples 9 | 1.0.0-SNAPSHOT 10 | 11 | 12 | true 13 | 1.3.72 14 | UTF-8 15 | UTF-8 16 | 17 | 18 | 19 | 20 | io.github.wechaty 21 | wechaty 22 | 0.1.5-SNAPSHOT 23 | 24 | 25 | 26 | org.apache.logging.log4j 27 | log4j-api 28 | 2.13.1 29 | 30 | 31 | 32 | org.apache.logging.log4j 33 | log4j-core 34 | 2.13.2 35 | 36 | 37 | org.apache.logging.log4j 38 | log4j-slf4j-impl 39 | 2.13.1 40 | 41 | 42 | 43 | com.lmax 44 | disruptor 45 | 3.4.2 46 | 47 | 48 | 49 | 50 | 51 | oss-sonatype 52 | oss-sonatype 53 | https://oss.sonatype.org/content/repositories/snapshots/ 54 | 55 | true 56 | 57 | 58 | 59 | alimaven 60 | aliyun maven 61 | https://maven.aliyun.com/nexus/content/groups/public/ 62 | 63 | true 64 | 65 | 66 | false 67 | 68 | 69 | 70 | 71 | 72 | 73 | aliyun-plugin 74 | https://maven.aliyun.com/repository/public 75 | 76 | true 77 | 78 | 79 | false 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | org.jetbrains.kotlin 88 | kotlin-maven-plugin 89 | ${kotlin.version} 90 | 91 | 92 | compile 93 | 94 | compile 95 | 96 | 97 | 98 | ${project.basedir}/src/main/kotlin 99 | ${project.basedir}/src/main/java 100 | 101 | 102 | 103 | 104 | test-compile 105 | 106 | test-compile 107 | 108 | 109 | 110 | ${project.basedir}/src/test/kotlin 111 | ${project.basedir}/src/test/java 112 | 113 | 114 | 115 | 116 | 117 | 118 | org.apache.maven.plugins 119 | maven-compiler-plugin 120 | 3.8.0 121 | 122 | 1.8 123 | 1.8 124 | 125 | 126 | 127 | 128 | default-compile 129 | none 130 | 131 | 132 | 133 | default-testCompile 134 | none 135 | 136 | 137 | java-compile 138 | compile 139 | 140 | compile 141 | 142 | 143 | 144 | java-test-compile 145 | test-compile 146 | 147 | testCompile 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | org.apache.maven.plugins 156 | maven-assembly-plugin 157 | 3.1.1 158 | 159 | 160 | make-assembly 161 | package 162 | 163 | single 164 | 165 | 166 | 167 | 168 | io.github.wechaty.DingDongBot 169 | 170 | 171 | 172 | jar-with-dependencies 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | -------------------------------------------------------------------------------- /examples/src/main/java/io/github/wechaty/DingDongBot.java: -------------------------------------------------------------------------------- 1 | package io.github.wechaty; 2 | 3 | 4 | import io.github.wechaty.user.Contact; 5 | import io.github.wechaty.user.Room; 6 | import io.github.wechaty.utils.QrcodeUtils; 7 | import org.apache.commons.lang3.StringUtils; 8 | 9 | 10 | public class DingDongBot { 11 | 12 | 13 | public static void main(String[] args) throws Exception { 14 | 15 | final String token = System.getenv("WECHATY_PUPPET_SERVICE_TOKEN"); 16 | 17 | if (StringUtils.isBlank(token)) { 18 | 19 | System.out.println("Error: WECHATY_PUPPET_SERVICE_TOKEN is not found in the environment variables"); 20 | System.out.println("You need a TOKEN to run the Java Wechaty. Please goto our README for details"); 21 | System.out.println("https://github.com/wechaty/java-wechaty-getting-started/#run"); 22 | 23 | throw new Exception("need a token"); 24 | } 25 | Wechaty bot = Wechaty.instance(token); 26 | 27 | 28 | bot.onScan((qrcode, statusScanStatus, data) -> { 29 | System.out.println(QrcodeUtils.getQr(qrcode)); 30 | System.out.println("Online Image: https://wechaty.github.io/qrcode/" + qrcode); 31 | }); 32 | 33 | bot.onMessage(message -> { 34 | 35 | Contact from = message.from(); 36 | Room room = message.room(); 37 | 38 | String text = message.text(); 39 | 40 | if (StringUtils.equals(text, "#ding")) { 41 | if (room != null) { 42 | room.say("dong"); 43 | } else { 44 | from.say("dong"); 45 | } 46 | } 47 | }); 48 | 49 | bot.start(true); 50 | 51 | } 52 | 53 | 54 | } 55 | -------------------------------------------------------------------------------- /examples/src/main/kotlin/io/github/wechaty/ding-dong-bot.kt: -------------------------------------------------------------------------------- 1 | // To be write ... 2 | -------------------------------------------------------------------------------- /examples/src/main/resources/log4j2.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | --------------------------------------------------------------------------------