# serverchan-spring-boot-starter

**Repository Path**: wyulong/serverchan-spring-boot-starter

## Basic Information

- **Project Name**: serverchan-spring-boot-starter
- **Description**: SpringBoot工程集成Server酱推送服务
Server酱：http://sc.ftqq.com
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2019-09-10
- **Last Updated**: 2024-07-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SpringBoot starter for Serverchan 
Server酱推送服务starter，通过本starter可以快速集成Server酱推送服务到springboot工程  
Server酱网址: [https://sc.ftqq.com](https://sc.ftqq.com)

## 快速开始
### 添加pom依赖
```xml
<dependency>
    <groupId>com.lnold</groupId>
    <artifactId>serverchan-spring-boot-starter</artifactId>
    <version>1.0.0</version>
</dependency>
```
### 添加server酱配置
application.properties中添加starter的配置  
**sckey需通过[Server酱网站](https://sc.ftqq.com)注册帐户后获取**

```properties
# server酱sckey
spring.serverchan.sckey=YOUR_SCKEY
```

### 使用
注入ServerchanService，即可按照普通Service使用  
示例代码：
```java
import com.lnold.serverchan.PushResult;
import com.lnold.serverchan.ServerchanService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {

    @Autowired
    private ServerchanService serverchanService;

    @PostMapping("/push")
    public PushResult push(String title,String content){
        PushResult result = serverchanService.sendMessage(title, content);
        if (result.isSuccess()){
            //doSomething()
        }else{
            //doOtherthing()
        }
        return result;
    }
}
```