io.github.xuhai19901018:wechaty-puppet

java-wechaty

Connecting Chatbots

Wechaty is a RPA SDK for Wechat Individual Account that can help you create a chatbot in 6 lines of Java.

Voice of the Developers

"Wechaty is a great solution, I believe there would be much more users recognize it." link
— @Gcaufy, Tencent Engineer, Author of WePY

"太好用，好用的想哭"
— @xinbenlv, Google Engineer, Founder of HaoShiYou.org

"最好的微信开发库" link
— @Jarvis, Baidu Engineer

"Wechaty让运营人员更多的时间思考如何进行活动策划、留存用户，商业变现" link
— @lijiarui, Founder & CEO of Juzi.BOT.

"If you know js ... try Wechaty, it's easy to use."
— @Urinx Uri Lee, Author of WeixinBot(Python)

See more at Wiki:Voice Of Developer

Join Us

Wechaty is used in many ChatBot projects by thousands of developers. If you want to talk with other developers, just scan the following QR Code in WeChat with secret code java wechaty, join our Wechaty Java Developers' Home.

Scan now, because other Wechaty Java developers want to talk with you too! (secret code: java wechaty)

The World's Shortest Java ChatBot: 6 lines of Code

class Bot{
  public static void main(String args[]){
    Wechaty bot = Wechaty.instance()
      .onScan((qrcode, statusScanStatus, data) -> System.out.println(QrcodeUtils.getQr(qrcode)))
      .onLogin(user -> System.out.println("User logined :" + user))
      .onMessage(message -> System.out.println("Message:" + message))
      .start(true);
  }
}

if use plugins

class Bot{
  public static void main(String args[]){
    Wechaty bot = Wechaty.instance()
            .use(
                WechatyPlugins.ScanPlugin(), 
                WechatyPlugins.DingDongPlugin(null))
            .start(true);
  }
}

Development

To be writen:

make install
make bot

Java Wechaty Developing Plan

We already have Wechaty in TypeScript, It will be not too hard to translate the TypeScript(TS) to Java because wechaty has only 3,000 lines of the TS code, they are well designed and de-coupled by the wechaty-puppet abstraction. So after we have translated those 3,000 lines of TypeScript code, we will almost be done.

As we have already a ecosystem of Wechaty in TypeScript, so we will not have to implement everything in Java, especially, in the Feb 2020, we have finished the @chatie/grpc service abstracting module with the wechaty-puppet-hostie implmentation.

The following diagram shows out that we can reuse almost everything in TypeScript, and what we need to do is only the block located at the top right of the diagram: Wechaty (Java).

  +--------------------------+ +--------------------------+
  |                          | |                          |
  |   Wechaty (TypeScript)   | |     Wechaty (Java)       |
  |                          | |                          |
  +--------------------------+ +--------------------------+

  +-------------------------------------------------------+
  |                 Wechaty Puppet Hostie                 |
  |                                                       |
  |                (wechaty-puppet-hostie)                |
  +-------------------------------------------------------+

+---------------------  @chatie/grpc  ----------------------+

  +-------------------------------------------------------+
  |                Wechaty Puppet Abstract                |
  |                                                       |
  |                   (wechaty-puppet)                    |
  +-------------------------------------------------------+

  +--------------------------+ +--------------------------+
  |      Pad Protocol        | |      Web Protocol        |
  |                          | |                          |
  | wechaty-puppet-padplus   | |(wechaty-puppet-puppeteer)|
  +--------------------------+ +--------------------------+
  +--------------------------+ +--------------------------+
  |    Windows Protocol      | |       Mac Protocol       |
  |                          | |                          |
  | (wechaty-puppet-windows) | | (wechaty-puppet-macpro)  |
  +--------------------------+ +--------------------------+

Example: How to Translate TypeScript to Java

There's a 100 lines class named Image in charge of downloading the WeChat image to different sizes.

It is a great example for demonstrating how do we translate the TypeScript to Java in Wechaty Way:

Image Class Source Code

• TypeScript: https://github.com/wechaty/wechaty/blob/master/src/user/image.ts
• Java: https://github.com/wechaty/java-wechaty/blob/master/src/wechaty/user/image.py

If you are interested in the translation and want to look at how it works, it will be a good start from reading and comparing those two Image class files in TypeScript and Java at the same time.

To-do List

• TS: TypeScript
• SLOC: Source Lines Of Code

Wechaty Internal Modules

1. Class Wechaty
   • TS SLOC(1160): https://github.com/wechaty/wechaty/blob/master/src/wechaty.ts
   • Code
   • Unit Tests
   • Documentation
2. Class Contact
   • TS SLOC(804): https://github.com/wechaty/wechaty/blob/master/src/user/contact.ts
   • Code
   • Unit Tests
   • Documentation
3. Class ContactSelf
   • TS SLOC(199): https://github.com/wechaty/wechaty/blob/master/src/user/contact-self.ts
   • Code
   • Unit Tests
   • Documentation
4. Class Message
   • TS SLOC(1054): https://github.com/wechaty/wechaty/blob/master/src/user/message.ts
   • Code
   • Unit Tests
   • Documentation
5. Class Room
   • TS SLOC(1194): https://github.com/wechaty/wechaty/blob/master/src/user/room.ts
   • Code
   • Unit Tests
   • Documentation
6. Class Image
   • TS SLOC(60): https://github.com/wechaty/wechaty/blob/master/src/user/image.ts
   • Code
   • Unit Tests
   • Documentation
7. Class Accessory
   • TS SLOC(179): https://github.com/wechaty/wechaty/blob/master/src/accessory.ts
   • Code
   • Unit Tests
   • Documentation
8. Class Config
   • TS SLOC(187): https://github.com/wechaty/wechaty/blob/master/src/config.ts
   • Code
   • Unit Tests
   • Documentation
9. Class Favorite
   • TS SLOC(52): https://github.com/wechaty/wechaty/blob/master/src/user/favorite.ts
   • Code
   • Unit Tests
   • Documentation
10. Class Friendship
    • TS SLOC(417): https://github.com/wechaty/wechaty/blob/master/src/user/friendship.ts
    • Code
    • Unit Tests
    • Documentation
11. Class MiniProgram
    • TS SLOC(70): https://github.com/wechaty/wechaty/blob/master/src/user/mini-program.ts
    • Code
    • Unit Tests
    • Documentation
12. Class RoomInvitation
    • TS SLOC(317): https://github.com/wechaty/wechaty/blob/master/src/user/room-invitation.ts
    • Code
    • Unit Tests
    • Documentation
13. Class Tag
    • TS SLOC(190): https://github.com/wechaty/wechaty/blob/master/src/user/tag.ts
    • Code
    • Unit Tests
    • Documentation
14. Class UrlLink
    • TS SLOC(107): https://github.com/wechaty/wechaty/blob/master/src/user/url-link.ts
    • Code
    • Unit Tests
    • Documentation

Wechaty External Modules

1. Class FileBox
   • TS SLOC(638): https://github.com/huan/file-box/blob/master/src/file-box.ts
   • Code
   • Unit Tests
   • Documentation
2. Class MemoryCard
   • TS SLOC(376): https://github.com/huan/memory-card/blob/master/src/memory-card.ts
   • Code
   • Unit Tests
   • Documentation
3. Class WechatyPuppet
   • TS SLOC(1115): https://github.com/wechaty/wechaty-puppet/blob/master/src/puppet.ts
   • Code
   • Unit Tests
   • Documentation
4. Class WechatyPuppetHostie
   • TS SLOC(909): https://github.com/wechaty/wechaty-puppet-hostie/blob/master/src/client/puppet-hostie.ts
   • Code
   • Unit Tests
   • Documentation

Usage

1. Add a token to class io.github.wechaty.example.Main in folder examples/src/main/java

2. Build:

   cd examples/  
   mvn install
   

3. Run

   java -jar target/wechaty-example-1.0.0-SNAPSHOT-jar-with-dependencies.jar
   # or run in background  
   nohup java -jar target/wechaty-example-1.0.0-SNAPSHOT-jar-with-dependencies.jar &>> nohup.out & tailf nohup.out
   

4. enjoy

Requirements

1. JDK/JRE

Install

mvn install wechaty

Links

1. Publish Java Module to Maven Central Repo - OSSRH Guide
2. Kotlin vs Java: Most Important Differences That You Must Know

History

master

v0.4 (Jun 19, 2020)

Java(Kotlin) Wechaty BETA Released!

Read more from our Multi-language Wechaty Beta Release event from our blog:

• Multi Language Wechaty Beta Release Announcement!

v0.1.4 (June 13 2020)

1. use PuppetManager to manage multi puppet implementations.
2. add mock puppet.
3. remove puppet implementations from wechaty pom. Which implementation to use depends on which implementation jar in your pom.
4. fix some bugs.

v0.1.3 (June 6 2020)

1. support plugins!

v0.1.2 (June 6 2020)

1. change method on(Event:String,Listener:listener) to onEvent(Listener:listener). See examples
2. update version to 0.1.2
3. update wechaty grpc to 0.16.1
4. move examples from wechaty to independent module. Make example easy to use.

v0.1.1 (May 31 2020)

1. update version to 0.1.1-SNAPSHOT
2. finish all function of room
3. remove log4j2 package from wechaty
4. change all log level to debug
5. remove log4j2.xml from wechaty

v0.1 (May 18 2020)

We decided to use Kotlin to develop the Java Wechaty!

1. Project re-inited by overwriting wechaty/java-wechaty by diaozxin/kotlin-wechaty.
2. Second contributor joined: @redmaple1 Xiaoya Ren

v0.0.1 (Mar 12, 2020)

1. Project created.
2. First contributor joined: @diaozxin007 Zhengxin DIAO (刁政欣)

Related Projects

• Wechaty - Conversatioanl AI Chatot SDK for Wechaty Individual Accounts (TypeScript)
• Python Wechaty - Python WeChaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Python)
• Go Wechaty - Go WeChaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Go)
• Java Wechaty - Java WeChaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Java)
• Scala Wechaty - Scala WeChaty Conversational AI Chatbot SDK for WechatyIndividual Accounts (Scala)

Stargazers over time

Badge

[![Wechaty in Kotlin](https://img.shields.io/badge/Wechaty-Kotlin-orange)](https://github.com/wechaty/java-wechaty)

Contributors

Committers

• @redmaple1 Xiaoya Ren
• @huan - Huan LI (李卓桓)

Creator

• @diaozxin007 [e-mail]
  • Website: 犀利豆的博客

Copyright & License

• Code & Docs © 2020 Wechaty Contributors https://github.com/wechaty
• Code released under the Apache-2.0 License
• Docs released under Creative Commons