微信小程序、公众号订阅消息模板正则参数校验

2025-07-15后端3 分钟194 次阅读
AI 摘要salmon-ai

本文详细解析了微信小程序和公众号订阅消息模板的参数正则校验方案,针对后台自定义配置模板时可能出现的参数格式错误问题,给出了一套可直接落地的校验工具类设计。文章结合微信官方订阅消息字段限制,

前言

最近有个业务场景,需要在后台增加自定义配置订阅消息模板,用来发送一些活动相关信息,比如优惠券,但如果参数格式不正确,会导致订阅消息发不出去,所以在创建模板的时候需要校验参数格式。

订阅通知参数值内容限制说明:
image.png

官方文档:https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/subscribe-message/sendMessage.html

代码

校验工具类

java 复制代码
package com.rlbsx.external.weixin.utils;

import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.regex.Pattern;

/**
 * 微信模板内容字段校验器
 * <a href="https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/subscribe-message/sendMessage.html">...</a>
 * @author Salmon
 * @since 2025-07-14 16:03
 */
public class WxTemplateFieldValidator {

    private static final Map<String, Pattern> RULES = new HashMap<>();
    private static final Map<String, String> FORMAT_HINT = new HashMap<>();

    static {
        RULES.put("thing", Pattern.compile("^[^\\n]{1,20}$"));
        FORMAT_HINT.put("thing", "最多20个字符,可包含汉字、数字、字母或符号");
        RULES.put("character_string", Pattern.compile("^[^\\n]{1,32}$"));
        FORMAT_HINT.put("character_string", "最多32个字符,可含数字/字母/符号");
        RULES.put("number", Pattern.compile("^\\d{1,32}(\\.\\d+)?$"));
        FORMAT_HINT.put("number", "最多32位数字,可带小数");
        RULES.put("letter", Pattern.compile("^[A-Za-z]{1,32}$"));
        FORMAT_HINT.put("letter", "最多32位,只能包含字母");
        RULES.put("symbol", Pattern.compile("^[^\\w\\s]{1,5}$"));
        FORMAT_HINT.put("symbol", "最多5位,仅符号,不可包含空格或换行");
        // 24小时制时间格式(支持+年月日),支持填时间段,两个时间点之间用“~”符号连接
        RULES.put("time", Pattern.compile("^[\\d]{4}[-/.年]\\d{1,2}[-/.月]\\d{1,2}(日)?(~[\\d]{4}[-/.年]\\d{1,2}[-/.月]\\d{1,2}(日)?)?$"));
        FORMAT_HINT.put("time", "24小时制 HH:mm 或 HH:mm:ss,可为时间段“~”分隔");
        // 年月日格式(支持+24小时制时间),支持填时间段,两个时间点之间用“~”符号连接
        RULES.put("date", Pattern.compile("^[\\d]{4}[-/.年]\\d{1,2}[-/.月]\\d{1,2}(日)?(~[\\d]{4}[-/.年]\\d{1,2}[-/.月]\\d{1,2}(日)?)?$"));
        FORMAT_HINT.put("date", "日期格式支持 YYYY年MM月DD日 或 YYYY-MM-DD 等,可为时间段“~”分隔,例如:2025年12月12日,或:2025年12月12日 15:01");
        RULES.put("amount", Pattern.compile("^(¥|¥|\\$|€|R\\$)?\\d{1,12}(\\.\\d+)?元?$"));
        FORMAT_HINT.put("amount", "1个币种符号+最多12位数字,可带小数,末尾可有“元”");
        RULES.put("phone_number", Pattern.compile("^[+\\d][\\d\\-]{0,15}\\d$"));
        FORMAT_HINT.put("phone_number", "17位以内电话号码,可含数字、加号和“-”符号");
        RULES.put("car_number", Pattern.compile("^[\\u4e00-\\u9fa5A-Za-z][A-Za-z0-9挂学警港澳]{5,7}$"));
        FORMAT_HINT.put("car_number", "最多8位车牌:首位汉字/字母,末位可为挂/学/警等");
        RULES.put("phrase", Pattern.compile("^[\\u4e00-\\u9fa5]{1,5}$"));
        FORMAT_HINT.put("phrase", "最多5个纯汉字");
        RULES.put("name", Pattern.compile("^([\\u4e00-\\u9fa5]{1,10}|[A-Za-z]{1,20}|[\\u4e00-\\u9fa5A-Za-z]{1,10})$"));
        FORMAT_HINT.put("name", "中文≤10字,或英文字母≤20字,中英混合≤10字");
    }

    /**
     * 校验指定类型的值是否有效;失败时返回格式提示
     *
     * @param key   参数类型,如 thing, number, date 等
     * @param value 字段值
     * @return Optional.empty() 校验通过;或 Optional.of(提示信息)
     */
    public static Optional<String> validate(String key, String value) {
        if (value == null || value.isEmpty()) {
            return Optional.of("此项必填");
        }
        Pattern p = RULES.get(key);
        String hint = FORMAT_HINT.getOrDefault(key, null);
        if (p == null) {
            return Optional.of("未知字段类型: " + key);
        }
        if (!p.matcher(value).matches()) {
            return Optional.of("格式错误,应满足:" + hint);
        }
        return Optional.empty();
    }
}

测试

java 复制代码
    /**
     * 校验模板内容
     *
     * @param templateContent 微信模板内容 券名称:{{thing1.DATA}}\n数量:{{number2.DATA}}\n获取时间:{{date3.DATA}}\n温馨提示:{{thing5.DATA}}
     * @param paramList       模板参数列表  ["1111","xxx","2021-01-01","xxxxx"]
     */
    private static void checkTemplateContent(String templateContent, List<String> paramList) {
        if (templateContent == null || paramList == null) {
            throw new BusinessException("模板内容或参数列表不能为空");
        }
        // 匹配 {{thing1.DATA}}、{{date3.DATA}} 这种格式
        Pattern pattern = Pattern.compile("\\{\\{(\\w+?)(\\d+)\\.DATA}}");
        Matcher matcher = pattern.matcher(templateContent);

        List<String> paramTypes = new ArrayList<>();
        while (matcher.find()) {
            // e.g., "thing", "number"
            String type = matcher.group(1);
            paramTypes.add(type);
        }

        if (paramTypes.isEmpty()) {
            throw new BusinessException("模板中未发现任何参数占位符");
        }

        if (paramTypes.size() != paramList.size()) {
            throw new BusinessException(String.format("参数数量不匹配,模板需 %d 个,实际传入 %d 个", paramTypes.size(), paramList.size()));
        }

        for (int i = 0; i < paramTypes.size(); i++) {
            String type = paramTypes.get(i);
            String value = paramList.get(i);

            Optional<String> error = WxTemplateFieldValidator.validate(type, value);
            if (error.isPresent()) {
                throw new BusinessException(String.format("第 %d 个参数 [%s] 校验失败:%s", i + 1, value, error.get()));
            }
        }
    }

    public static void main(String[] args) {
        String templateContent = "券名称:{{thing1.DATA}}\n数量:{{number2.DATA}}\n获取时间:{{date3.DATA}}\n温馨提示:{{thing5.DATA}}";
        List<String> paramList = Arrays.asList("1111", "xxx", "2021-01-01", "xxxxx");
        checkTemplateContent(templateContent, paramList);
    }
觉得有用就点个赞,不用登录也能读

评论

0 条
登录 之后才能评论
—
还没有评论,来说第一句