# mars-push

**Repository Path**: Marsfactory/mars-push

## Basic Information

- **Project Name**: mars-push
- **Description**: 一个轻量级、可插拔的服务端消息推送框架。一键集成推送（华为推送、oppo推送、vivo、小米推送等），提供有效的保活机制，支持推送的拓展，充分解耦推送和业务逻辑，解放你的双手！
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 7
- **Forks**: 3
- **Created**: 2021-03-08
- **Last Updated**: 2025-05-03

## Categories & Tags

**Categories**: android-modules

**Tags**: None

## README

# mars-push-spring-boot-starter

#### 介绍

一个轻量级、可插拔的服务端消息推送框架。一键集成推送（华为推送、oppo推送、vivo、小米推送等），提供有效的保活机制，支持推送的拓展，充分解耦推送和业务逻辑，解放你的双手！

#### 使用说明

1. 创建Spring Boot项目
2. 引入maven依赖
   ```  
        <dependency>
            <groupId>com.mars</groupId>
            <artifactId>mars-push-spring-boot-starter</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
   ```
3. 在Spring Boot的项目配置文件application.yml中添加相应的配置，如：
   ```
   push:
      #华为推送
      huawei:
         clientId: 
         clientSecrect: 
      vivo:
         #vivo 推送
         appId: 
         appKey: 
         appSecret: 
      xiaomi:
         #小米推送
         appId: 
         appKey: 
         appSecret: 
      oppo:
         #oppo推送
         appId: 
         appKey: 
         appSecret: 
         masterSecret: 
   ```
4. 在controller 如:
   ```
   @Resource
    private HuaweiPushImpl huaweiPush;

    @Resource
    private XiaomiPushServiceImpl xiaomiPush;

    @Resource
    private VivoPushServiceImpl vivoPush;

    @Resource
    private OppoPushServiceImpl oppoPush;

    /**
     * 消息推送
     *
     * @param request request
     * @return String
     */
    @PostMapping("/push")
    public String send(@RequestBody PushRequest request) {
        try {
            switch (request.getDevice()) {
                case "huawei":
                    huaweiPush.send(request);
                case "xiaomi":
                    xiaomiPush.send(request);
                case "vivo":
                    vivoPush.send(request);
                case "oppo":
                    oppoPush.send(request);
                default:
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return "success";
    }
   ```
  

   DEMO地址如下：https://gitee.com/WQLOVEPEACE_admin/mars-push/tree/master/mars-springboot-push-starter

#### QQ交流群

群号：760772667

#### 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request