新增极光推送

shaofan
1 parent a417d65d
Showing 14 changed files with 468 additions and 5 deletions
pom.xml
src/main/java/com/diligrp/rider/config/JPushConfig.java
src/main/java/com/diligrp/rider/config/JPushProperties.java
src/main/java/com/diligrp/rider/controller/RiderDeviceController.java
src/main/java/com/diligrp/rider/dto/DeviceBindDTO.java
src/main/java/com/diligrp/rider/entity/RiderDevice.java
src/main/java/com/diligrp/rider/mapper/RiderDeviceMapper.java
src/main/java/com/diligrp/rider/service/JPushService.java
src/main/java/com/diligrp/rider/service/RiderDeviceService.java
src/main/java/com/diligrp/rider/service/impl/AdminMessageServiceImpl.java
src/main/java/com/diligrp/rider/service/impl/JPushServiceImpl.java
src/main/java/com/diligrp/rider/service/impl/RiderDeviceServiceImpl.java
src/main/resources/application.yml
src/main/resources/schema.sql
@@ -85,6 +85,13 @@
             <scope>runtime</scope>
         </dependency>
  
+        <!-- 极光推送 -->
+        <dependency>
+            <groupId>cn.jpush.api</groupId>
+            <artifactId>jpush-client</artifactId>
+            <version>3.6.6</version>
+        </dependency>
+
         <!-- Test -->
         <dependency>
             <groupId>org.springframework.boot</groupId>
+package com.diligrp.rider.config;
+
+import cn.jpush.api.JPushClient;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * JPushClient Bean 装配
+ *
+ * 即使 jpush.enabled=false 也会创建一个 client（避免依赖注入失败），
+ * 调用时由 JPushService 检查 enabled 开关决定是否真的发起推送。
+ */
+@Slf4j
+@Configuration
+@RequiredArgsConstructor
+public class JPushConfig {
+
+    private final JPushProperties properties;
+
+    @Bean
+    public JPushClient jPushClient() {
+        if (!properties.isEnabled()) {
+            log.warn("JPush 未启用（jpush.enabled=false），将创建占位 client，所有推送会被跳过");
+        }
+        // 即便未启用，也用占位值构造，避免 NPE
+        String masterSecret = properties.getMasterSecret() != null ? properties.getMasterSecret() : "placeholder";
+        String appKey = properties.getAppKey() != null ? properties.getAppKey() : "placeholder";
+        return new JPushClient(masterSecret, appKey);
+    }
+}
+package com.diligrp.rider.config;
+
+import lombok.Data;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * 极光推送配置
+ */
+@Data
+@Configuration
+@ConfigurationProperties(prefix = "jpush")
+public class JPushProperties {
+
+    /** 是否启用 JPush；false 时所有推送调用静默跳过 */
+    private boolean enabled = false;
+
+    /** AppKey */
+    private String appKey;
+
+    /** MasterSecret */
+    private String masterSecret;
+
+    /** iOS APNs 是否生产环境 */
+    private boolean apnsProduction = false;
+
+    /** 离线消息保留秒数 */
+    private int timeToLive = 86400;
+}
+package com.diligrp.rider.controller;
+
+import com.diligrp.rider.common.result.Result;
+import com.diligrp.rider.dto.DeviceBindDTO;
+import com.diligrp.rider.service.RiderDeviceService;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * 骑手端推送设备绑定接口
+ */
+@RestController
+@RequestMapping("/api/rider/device")
+@RequiredArgsConstructor
+public class RiderDeviceController {
+
+    private final RiderDeviceService deviceService;
+
+    /**
+     * 登录后绑定 JPush registrationId
+     */
+    @PostMapping("/bind")
+    public Result<Void> bind(@Valid @RequestBody DeviceBindDTO dto, HttpServletRequest request) {
+        Long riderId = (Long) request.getAttribute("riderId");
+        deviceService.bind(riderId, dto);
+        return Result.success();
+    }
+
+    /**
+     * 退出登录时解绑
+     */
+    @PostMapping("/unbind")
+    public Result<Void> unbind(@RequestParam String registrationId, HttpServletRequest request) {
+        Long riderId = (Long) request.getAttribute("riderId");
+        deviceService.unbind(riderId, registrationId);
+        return Result.success();
+    }
+}
+package com.diligrp.rider.dto;
+
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
+import lombok.Data;
+
+/**
+ * 骑手端设备绑定参数
+ */
+@Data
+public class DeviceBindDTO {
+
+    /** JPush 注册ID */
+    @NotBlank(message = "registrationId 不能为空")
+    private String registrationId;
+
+    /** 平台：1=Android 2=iOS */
+    @NotNull(message = "platform 不能为空")
+    private Integer platform;
+
+    /** 设备信息（可选） */
+    private String deviceInfo;
+
+    /** App 版本（可选） */
+    private String appVersion;
+}
+package com.diligrp.rider.entity;
+
+import com.baomidou.mybatisplus.annotation.IdType;
+import com.baomidou.mybatisplus.annotation.TableId;
+import com.baomidou.mybatisplus.annotation.TableName;
+import lombok.Data;
+
+/**
+ * 骑手设备推送绑定表
+ */
+@Data
+@TableName("rider_device")
+public class RiderDevice {
+
+    @TableId(type = IdType.AUTO)
+    private Long id;
+
+    /** 骑手ID */
+    private Long riderId;
+
+    /** JPush 设备注册ID */
+    private String registrationId;
+
+    /** 平台：1=Android 2=iOS */
+    private Integer platform;
+
+    /** 设备信息（型号/系统版本） */
+    private String deviceInfo;
+
+    /** App 版本 */
+    private String appVersion;
+
+    /** 状态：0=已解绑 1=正常 */
+    private Integer status;
+
+    /** 最近活跃时间 */
+    private Long lastActiveTime;
+
+    private Long createTime;
+
+    private Long updateTime;
+}
+package com.diligrp.rider.mapper;
+
+import com.baomidou.mybatisplus.core.mapper.BaseMapper;
+import com.diligrp.rider.entity.RiderDevice;
+import org.apache.ibatis.annotations.Mapper;
+
+@Mapper
+public interface RiderDeviceMapper extends BaseMapper<RiderDevice> {
+}
+package com.diligrp.rider.service;
+
+/**
+ * 极光推送服务
+ *
+ * 推送目标统一使用 alias = riderId 字符串；
+ * App 端登录后须调用 JPushFlutter.setAlias(riderId) 完成绑定。
+ */
+public interface JPushService {
+
+    /**
+     * 推送给单个骑手
+     *
+     * @param riderId 骑手ID（作为 JPush alias）
+     * @param title   通知标题
+     * @param content 通知正文
+     * @param bizType 业务类型（透传到 App，用于点击跳转）
+     * @param bizId   业务ID（如订单ID）
+     */
+    void pushToRider(Long riderId, String title, String content, String bizType, Long bizId);
+
+    /**
+     * 按城市广播（按 tag = "city_<cityId>"，App 端登录时按所属城市设置 tag）
+     */
+    void pushToCity(Long cityId, String title, String content, String bizType);
+}
+package com.diligrp.rider.service;
+
+import com.diligrp.rider.dto.DeviceBindDTO;
+
+/**
+ * 骑手设备绑定服务
+ */
+public interface RiderDeviceService {
+
+    /**
+     * 登录后绑定设备（同 registrationId 已存在则刷新归属与活跃时间）
+     */
+    void bind(Long riderId, DeviceBindDTO dto);
+
+    /**
+     * 退出登录时解绑（按 registrationId）
+     */
+    void unbind(Long riderId, String registrationId);
+}
@@ -10,6 +10,7 @@ import com.diligrp.rider.mapper.RiderMapper;
 import com.diligrp.rider.mapper.RiderMessageMapper;
 import com.diligrp.rider.mapper.RiderMessageTemplateMapper;
 import com.diligrp.rider.service.AdminMessageService;
+import com.diligrp.rider.service.JPushService;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Service;
@@ -28,6 +29,7 @@ public class AdminMessageServiceImpl implements AdminMessageService {
     private final RiderMessageMapper messageMapper;
     private final RiderMessageTemplateMapper templateMapper;
     private final RiderMapper riderMapper;
+    private final JPushService jPushService;
  
     private static final int PAGE_SIZE = 20;
  
@@ -37,6 +39,15 @@ public class AdminMessageServiceImpl implements AdminMessageService {
         ensureCitySelected(cityId);
         ensureRiderInCity(cityId, riderId);
  
+        long messageId = insertMessage(cityId, riderId, type, title, content, bizType, bizId);
+        log.info("发送消息成功，riderId={} messageId={}", riderId, messageId);
+
+        // 写库后触发推送（管理员手动单发：总是推送）
+        jPushService.pushToRider(riderId, title, content, bizType, bizId);
+    }
+
+    private long insertMessage(Long cityId, Long riderId, Integer type, String title,
+                               String content, String bizType, Long bizId) {
         RiderMessage message = new RiderMessage();
         message.setCityId(cityId);
         message.setRiderId(riderId);
@@ -48,9 +59,8 @@ public class AdminMessageServiceImpl implements AdminMessageService {
         message.setIsRead(0);
         message.setCreateTime(System.currentTimeMillis());
         message.setReadTime(0L);
-
         messageMapper.insert(message);
-        log.info("发送消息成功，riderId={} messageId={}", riderId, message.getId());
+        return message.getId();
     }
  
     @Override
@@ -96,6 +106,9 @@ public class AdminMessageServiceImpl implements AdminMessageService {
         }
  
         log.info("群发消息成功，cityId={} 骑手数={}", cityId, riders.size());
+
+        // 写库后按城市 tag 触发广播推送
+        jPushService.pushToCity(cityId, title, content, "broadcast");
     }
  
     @Override
@@ -164,9 +177,15 @@ public class AdminMessageServiceImpl implements AdminMessageService {
         String title = replacePlaceholders(template.getTitleTemplate(), params);
         String content = replacePlaceholders(template.getContentTemplate(), params);
  
-        // 发送消息
+        // 模板的 is_push=1 时同步推送，否则仅入库
         Long bizId = params.get("bizId") != null ? Long.valueOf(params.get("bizId").toString()) : 0L;
-        sendToRider(cityId, riderId, template.getType(), title, content, bizType, bizId);
+        if (Integer.valueOf(1).equals(template.getIsPush())) {
+            sendToRider(cityId, riderId, template.getType(), title, content, bizType, bizId);
+        } else {
+            ensureCitySelected(cityId);
+            ensureRiderInCity(cityId, riderId);
+            insertMessage(cityId, riderId, template.getType(), title, content, bizType, bizId);
+        }
     }
  
     /**
+package com.diligrp.rider.service.impl;
+
+import cn.jiguang.common.resp.APIConnectionException;
+import cn.jiguang.common.resp.APIRequestException;
+import cn.jpush.api.JPushClient;
+import cn.jpush.api.push.PushResult;
+import cn.jpush.api.push.model.Options;
+import cn.jpush.api.push.model.Platform;
+import cn.jpush.api.push.model.PushPayload;
+import cn.jpush.api.push.model.audience.Audience;
+import cn.jpush.api.push.model.notification.AndroidNotification;
+import cn.jpush.api.push.model.notification.IosNotification;
+import cn.jpush.api.push.model.notification.Notification;
+import com.diligrp.rider.config.JPushProperties;
+import com.diligrp.rider.service.JPushService;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class JPushServiceImpl implements JPushService {
+
+    private final JPushClient jPushClient;
+    private final JPushProperties properties;
+
+    @Override
+    public void pushToRider(Long riderId, String title, String content, String bizType, Long bizId) {
+        if (!properties.isEnabled()) {
+            log.debug("JPush 未启用，跳过推送 riderId={} title={}", riderId, title);
+            return;
+        }
+        if (riderId == null || riderId <= 0) {
+            log.warn("riderId 无效，跳过推送 riderId={}", riderId);
+            return;
+        }
+        try {
+            PushPayload payload = buildPayload(
+                    Audience.alias(String.valueOf(riderId)),
+                    title, content, bizType, bizId);
+            PushResult result = jPushClient.sendPush(payload);
+            log.info("JPush 推送成功 riderId={} msgId={} sendno={}",
+                    riderId, result.msg_id, result.sendno);
+        } catch (APIConnectionException e) {
+            log.error("JPush 网络异常 riderId={}", riderId, e);
+        } catch (APIRequestException e) {
+            log.error("JPush 业务异常 riderId={} status={} errorCode={} msg={}",
+                    riderId, e.getStatus(), e.getErrorCode(), e.getErrorMessage());
+        } catch (Exception e) {
+            log.error("JPush 推送未知异常 riderId={}", riderId, e);
+        }
+    }
+
+    @Override
+    public void pushToCity(Long cityId, String title, String content, String bizType) {
+        if (!properties.isEnabled()) {
+            log.debug("JPush 未启用，跳过广播 cityId={} title={}", cityId, title);
+            return;
+        }
+        if (cityId == null || cityId <= 0) {
+            log.warn("cityId 无效，跳过广播 cityId={}", cityId);
+            return;
+        }
+        try {
+            PushPayload payload = buildPayload(
+                    Audience.tag("city_" + cityId),
+                    title, content, bizType, 0L);
+            PushResult result = jPushClient.sendPush(payload);
+            log.info("JPush 城市广播成功 cityId={} msgId={}", cityId, result.msg_id);
+        } catch (APIConnectionException e) {
+            log.error("JPush 城市广播网络异常 cityId={}", cityId, e);
+        } catch (APIRequestException e) {
+            log.error("JPush 城市广播业务异常 cityId={} status={} errorCode={} msg={}",
+                    cityId, e.getStatus(), e.getErrorCode(), e.getErrorMessage());
+        } catch (Exception e) {
+            log.error("JPush 城市广播未知异常 cityId={}", cityId, e);
+        }
+    }
+
+    private PushPayload buildPayload(Audience audience, String title, String content,
+                                     String bizType, Long bizId) {
+        AndroidNotification.Builder androidBuilder = AndroidNotification.newBuilder()
+                .setAlert(content)
+                .setTitle(title);
+        IosNotification.Builder iosBuilder = IosNotification.newBuilder()
+                .setAlert(content)
+                .incrBadge(1)
+                .setSound("default");
+
+        if (bizType != null && !bizType.isEmpty()) {
+            androidBuilder.addExtra("bizType", bizType);
+            iosBuilder.addExtra("bizType", bizType);
+        }
+        if (bizId != null) {
+            androidBuilder.addExtra("bizId", String.valueOf(bizId));
+            iosBuilder.addExtra("bizId", String.valueOf(bizId));
+        }
+
+        return PushPayload.newBuilder()
+                .setPlatform(Platform.android_ios())
+                .setAudience(audience)
+                .setNotification(Notification.newBuilder()
+                        .addPlatformNotification(androidBuilder.build())
+                        .addPlatformNotification(iosBuilder.build())
+                        .build())
+                .setOptions(Options.newBuilder()
+                        .setApnsProduction(properties.isApnsProduction())
+                        .setTimeToLive(properties.getTimeToLive())
+                        .build())
+                .build();
+    }
+}
+package com.diligrp.rider.service.impl;
+
+import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
+import com.baomidou.mybatisplus.core.conditions.update.LambdaUpdateWrapper;
+import com.diligrp.rider.dto.DeviceBindDTO;
+import com.diligrp.rider.entity.RiderDevice;
+import com.diligrp.rider.mapper.RiderDeviceMapper;
+import com.diligrp.rider.service.RiderDeviceService;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class RiderDeviceServiceImpl implements RiderDeviceService {
+
+    private final RiderDeviceMapper deviceMapper;
+
+    @Override
+    @Transactional
+    public void bind(Long riderId, DeviceBindDTO dto) {
+        long now = System.currentTimeMillis();
+
+        // 同一 registrationId 全局唯一：若已存在则覆盖归属
+        LambdaQueryWrapper<RiderDevice> wrapper = new LambdaQueryWrapper<>();
+        wrapper.eq(RiderDevice::getRegistrationId, dto.getRegistrationId());
+        RiderDevice existing = deviceMapper.selectOne(wrapper);
+
+        if (existing != null) {
+            existing.setRiderId(riderId);
+            existing.setPlatform(dto.getPlatform());
+            existing.setDeviceInfo(dto.getDeviceInfo() == null ? "" : dto.getDeviceInfo());
+            existing.setAppVersion(dto.getAppVersion() == null ? "" : dto.getAppVersion());
+            existing.setStatus(1);
+            existing.setLastActiveTime(now);
+            existing.setUpdateTime(now);
+            deviceMapper.updateById(existing);
+            log.info("设备绑定刷新 riderId={} registrationId={}", riderId, dto.getRegistrationId());
+            return;
+        }
+
+        RiderDevice device = new RiderDevice();
+        device.setRiderId(riderId);
+        device.setRegistrationId(dto.getRegistrationId());
+        device.setPlatform(dto.getPlatform());
+        device.setDeviceInfo(dto.getDeviceInfo() == null ? "" : dto.getDeviceInfo());
+        device.setAppVersion(dto.getAppVersion() == null ? "" : dto.getAppVersion());
+        device.setStatus(1);
+        device.setLastActiveTime(now);
+        device.setCreateTime(now);
+        device.setUpdateTime(now);
+        deviceMapper.insert(device);
+        log.info("设备绑定新增 riderId={} registrationId={}", riderId, dto.getRegistrationId());
+    }
+
+    @Override
+    @Transactional
+    public void unbind(Long riderId, String registrationId) {
+        if (registrationId == null || registrationId.isEmpty()) {
+            return;
+        }
+        long now = System.currentTimeMillis();
+        LambdaUpdateWrapper<RiderDevice> wrapper = new LambdaUpdateWrapper<>();
+        wrapper.eq(RiderDevice::getRegistrationId, registrationId)
+                .eq(RiderDevice::getRiderId, riderId)
+                .set(RiderDevice::getStatus, 0)
+                .set(RiderDevice::getUpdateTime, now);
+        deviceMapper.update(null, wrapper);
+        log.info("设备解绑 riderId={} registrationId={}", riderId, registrationId);
+    }
+}
@@ -31,6 +31,13 @@ jwt:
   secret: diligrp-rider-secret-key-2024-please-change-this
   expire: 604800  # 7天，单位秒
  
+jpush:
+  enabled: false                          # 未配置 AppKey 前置 false，避免启动时报错
+  app-key: your-jpush-app-key
+  master-secret: your-jpush-master-secret
+  apns-production: false                  # iOS APNs：true=生产 false=开发
+  time-to-live: 86400                     # 离线消息保留秒数（默认 1 天）
+
 logging:
   level:
     com.diligrp.rider: debug
@@ -581,4 +581,21 @@ INSERT INTO `rider_message_template` (`biz_type`, `type`, `title_template`, `con
 ('order_cancelled', 1, '订单取消', '订单 #{orderNo} 已被取消', 1),
 ('system_notice', 2, '系统通知', '#{content}', 1),
 ('level_upgrade', 2, '等级提升', '恭喜您，等级已提升至 #{levelName}', 1),
-('balance_change', 2, '余额变动', '您的余额发生变动，当前余额：#{balance} 元', 0);
 \ No newline at end of file
+('balance_change', 2, '余额变动', '您的余额发生变动，当前余额：#{balance} 元', 0);
+
+-- 骑手设备推送绑定表（极光推送）
+CREATE TABLE `rider_device` (
+  `id`               BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
+  `rider_id`         BIGINT UNSIGNED NOT NULL COMMENT '骑手ID',
+  `registration_id`  VARCHAR(64)     NOT NULL DEFAULT '' COMMENT 'JPush 设备注册ID',
+  `platform`         TINYINT         NOT NULL DEFAULT 0 COMMENT '平台：1=Android 2=iOS',
+  `device_info`      VARCHAR(255)    NOT NULL DEFAULT '' COMMENT '设备信息（型号/系统版本）',
+  `app_version`      VARCHAR(32)     NOT NULL DEFAULT '' COMMENT 'App 版本',
+  `status`           TINYINT         NOT NULL DEFAULT 1 COMMENT '状态：0=已解绑 1=正常',
+  `last_active_time` BIGINT UNSIGNED NOT NULL DEFAULT 0 COMMENT '最近活跃时间',
+  `create_time`      BIGINT UNSIGNED NOT NULL DEFAULT 0,
+  `update_time`      BIGINT UNSIGNED NOT NULL DEFAULT 0,
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `uk_registration_id` (`registration_id`),
+  KEY `idx_rider_status` (`rider_id`, `status`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='骑手设备推送绑定表';
 \ No newline at end of file