极光推送服务配置与使用指南

前言

本文将详细介绍如何在Spring Boot项目中集成极光（JPush）推送服务，并提供三种推送方式的实现方案。

服务端配置文件

在项目中添加极光推送的相关配置，安装完成后即可正常使用。

application.properties 配置

在application.properties文件中添加以下配置项：

jpush.appKey=12340856031dc012a7d456
jpush.masterSecret=123493e8a9be718f023023
jpush.liveTime=300000

##Spring Boot配置

添加依赖

在项目的POM文件中添加JPush客户端依赖：


   
    
    
     cn.jpush.api
    
    
    
     jpush-client
    
    
    
     3.3.4

配置文件处理

通过Spring注入配置信息，基本无需修改即可使用。配置示例如下：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
@Component("jpushConfig")
public class JpushConfig {
    @Value("${jpush.appKey}")
    private String appkey;
    @Value("${jpush.masterSecret}")
    private String masterSecret;
    @Value("${jpush.liveTime}")
    private String liveTime;
    public String getAppkey() { return appkey; }
    public String getMasterSecret() { return masterSecret; }
}

推送服务类封装

宽布包推送

提供多种推送方式的封装实现，确保推送过程高效且可靠。

推送方式

服务端控制推送内容方式

public PushResult sendPush(String title, String content, Map
   
     extrasMap, String... alias) {
    ClientConfig clientConfig = ClientConfig.getInstance();
    clientConfig.setTimeToLive(Long.valueOf(jpushConfig.getLiveTime()));
    JPushClient jpushClient = new JPushClient(jpushConfig.getMasterSecret(), jpushConfig.getAppkey(), null, clientConfig);
    PushPayload payload = buildPushPayload(title, content, extrasMap, alias);
    try {
        return jpushClient.sendPush(payload);
    } catch (APIConnectionException e) {
        LOG.error("极光推送连接错误，请稍后重试", e);
    } catch (APIRequestException e) {
        LOG.error("极光服务器响应出错，请修复！", e);
        LOG.info("HTTP Status: %d", e.getStatus());
        LOG.info("Error Code: %d", e.getErrorCode());
        LOG.info("Error Message: %s", e.getErrorMessage());
    }
}

服务端控制推送方式（带返回值）

public PushResult sendPushWithCallback(String title, String content, Map
   
     extrasMap, String... alias) {
    ClientConfig clientConfig = ClientConfig.getInstance();
    clientConfig.setTimeToLive(Long.valueOf(jpushConfig.getLiveTime()));
    String host = (String) clientConfig.get(ClientConfig.PUSH_HOST_NAME);
    NettyHttpClient client = new NettyHttpClient(ServiceHelper.getBasicAuthorization(jpushConfig.getAppkey(), jpushConfig.getMasterSecret()), null, clientConfig);
    try {
        URI uri = new URI(host + clientConfig.get(ClientConfig.PUSH_PATH));
        PushPayload payload = buildPushPayload(title, content, extrasMap, alias);
        client.sendRequest(HttpMethod.POST, payload.toString(), uri, new NettyHttpClient.BaseCallback() {
            @Override
            public void onSucceed(ResponseWrapper responseWrapper) {
                if (200 == responseWrapper.responseCode) {
                    LOG.info("极光推送成功");
                } else {
                    LOG.info("极光推送失败，返回结果: %s", responseWrapper.responseContent);
                }
            }
        });
    } catch (URISyntaxException e) {
        e.printStackTrace();
    } finally {
        client.close();
    }
}

客户端自定义显示推送方式

public PushResult sendCustomPush(String title, String content, Map
   
     extrasMap, String... alias) {
    ClientConfig clientConfig = ClientConfig.getInstance();
    clientConfig.setTimeToLive(Long.valueOf(jpushConfig.getLiveTime()));
    JPushClient jpushClient = new JPushClient(jpushConfig.getMasterSecret(), jpushConfig.getAppkey(), null, clientConfig);
    PushPayload payload = buildCustomPushPayload(title, content, extrasMap, alias);
    try {
        return jpushClient.sendPush(payload);
    } catch (APIConnectionException e) {
        LOG.error("极光推送连接错误，请稍后重试", e);
    } catch (APIRequestException e) {
        LOG.error("极光服务器响应出错，请修复！", e);
        LOG.info("HTTP Status: %d", e.getStatus());
        LOG.info("Error Code: %d", e.getErrorCode());
        LOG.info("Error Message: %s", e.getErrorMessage());
    }
}

使用方法

一键启动

通过简单配置即可快速集成极光推送服务。

推送示例

@Autowired
JpushService jpushService;
String title = "推送标题";
String content = "推送内容";
Map
   
     extrasMap = new HashMap<>();
extrasMap.put("extraKey", "extraValue");
// 使用方式一：默认推送
jpushService.sendPush(title, content, extrasMap);
// 使用方式二：带返回值
jpushService.sendPushWithCallback(title, content, extrasMap);