# AutoBus

**Repository Path**: bestyize/AutoBus

## Basic Information

- **Project Name**: AutoBus
- **Description**: 一个Android异步消息发布的框架
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-04
- **Last Updated**: 2021-03-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AutoBus

## 1、介绍

一个自写的发布订阅框架,主要作用是实现消息在组件之间的传递。
目前支持两种模式，一种需要自己注册和取消订阅事件（LiteBus）
另一种通过绑定activity生命周期来实现不需要自己注册或者取消事件(AutoBus)

第一种配置稍微麻烦一点，但是比较通用，普通类也可以使用
第二种不需要配置，拿来即用，但只能用在activity或者fragment中

已经支持方法的优先级，下一步支持消息的优先级

## 2、AutoBus使用方式

1、定义消息类型

```java
    class MyMessage{
        public final String msg;

        public MyMessage(String msg) {
            this.msg = msg;
        }
    }
```

2、在需要接受消息的方法上面声明注解,声明方法的工作线程和优先级

```java
    /**
     * 默认，主线程、中等优先级
     * @param message
     */
    @Subscribe
    public void receiver(MyMessage message){
        Log.i(TAG,message.msg);
    }
    /**
     * 默认主线程、中等优先级
     * @param message
     */
    @Subscribe(workMode = WorkMode.THREAD_MAIN,workPriority = WorkPriority.PRIORITY_DEFAULT)
    public void receiver2(MyMessage message){
        Log.i(TAG,message.msg);
    }
```

3、使用AutoBus发送消息

```java
    AutoBus.with(MainActivity.this).publish(new MyMessage("Hello AutoBus"));
```

## 3、LiteBus使用方式

### 3.1 基本用法

1、定义消息类型

```java
    class MyMessage{
        public final String msg;

        public MyMessage(String msg) {
            this.msg = msg;
        }
    }
```

2、在需要接受消息的方法上面声明注解,声明方法的工作线程和优先级

下面两种方式是等价的，在注解里面已默认设置，可以根据自己的需求改造

```java
    /**
     * 默认，主线程、中等优先级
     * @param message
     */
    @Subscribe
    public void receiver(MyMessage message){
        Log.i(TAG,message.msg);
    }
    /**
     * 默认主线程、中等优先级
     * @param message
     */
    @Subscribe(workMode = WorkMode.THREAD_MAIN,workPriority = WorkPriority.PRIORITY_DEFAULT)
    public void receiver2(MyMessage message){
        Log.i(TAG,message.msg);
    }
```
3、在onCreate中注册当前类

```java
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        LiteBus.defaultBus().register(this);
        ...
        ...
    }
```

4、在某个线程中发送消息

```java
    LiteBus.defaultBus().publish(new MyMessage("Hello LiteBus"));
```

5、重写onDestroy()取消当前类的注册

```java
    @Override
    protected void onDestroy() {
        super.onDestroy();
        LiteBus.defaultBus().unregister(this);
    }
```


### 3.2 周期，延时消息发布使用方法

注册过程和3.1中相同，不同的是发布调用的方法不同

1、周期发布

```java
    //第一个参数为我们需要传递的消息，第二个参数是重复次数，第三个参数是发布周期，以ms为单位
    LiteBus.defaultBus().publish(new MyMessage("定时消息"), 10, 1000);
```

2、延时发布

```java
    //第一个参数为我们需要传递的消息，第二个参数是延时时间，以ms为单位
    LiteBus.defaultBus().publish(new MyMessage("延时消息"),1000);
```



## 4、引入依赖

1、添加jitpack.io仓库(build.gradle(project))

```gradle
    buildscript {
        repositories {
            maven { url 'https://jitpack.io' }
            google()
            jcenter()
        }
        dependencies {
            classpath 'com.android.tools.build:gradle:3.6.3'
            // NOTE: Do not place your application dependencies here; they belong
            // in the individual module build.gradle files
        }
    }
    allprojects {
        repositories {
            maven { url 'https://jitpack.io' }
            google()
            jcenter()
        }
    }
```

2、引入AutoBus依赖(build.gradle(app))

```gradle
    implementation 'com.github.bestyize:AutoBus:v1.0.3'
```