RestTemplate设置固定的url参数-低调大师

RestTemplate设置固定的url参数

2020-10-30 489

在使用RestTemplate请求三方接口时：三方接口一般都要求在url后面拼接上固定的几个参数，一般如accessToken进行权限校验。而我们在开发时，请求这些地址，如何避免在url拼接accessToken这种重复固定的编码操作呢。

方法当然有很多，本文提供一种通过反射偷梁换柱的写法来实现。

以微信小程序服务端接口请求作为请求对象。

微信小程序要求在请求时带上 ?accesss_token=ACCESS_TOKEN

如何实现..?

# 基础配置

微信小程序配置类


/**
 * 微信小程序配置类
 *
 * @author futao
 * @date 2020/10/29
 */
@ConfigurationProperties(prefix = WxMiniProgramProperties.PROPERTY_PREFIX)
public class WxMiniProgramProperties {

    /**
     * 微信小程序配置前缀
     */
    public static final String PROPERTY_PREFIX = Consts.System.FRAMEWORK_BASE_NAME + "." + Consts.WxMiniProgram.WX_MINI_PROGRAM_BASE_NAME;

    /**
     * AppID(小程序ID)
     */
    private String appId;

    /**
     * AppSecret(小程序密钥)
     */
    private String appSecret;

    public String getAppId() {
        if (StringUtils.isBlank(appId)) {
            throw new WxMiniProgramException("微信小程序AppId未设置");
        }
        return appId;
    }

    public void setAppId(String appId) {
        this.appId = appId;
    }

    public String getAppSecret() {
        if (StringUtils.isBlank(appSecret)) {
            throw new WxMiniProgramException("微信小程序AppSecret未设置");
        }
        return appSecret;
    }

    public void setAppSecret(String appSecret) {
        this.appSecret = appSecret;
    }
}

获取微信小程序accessToken


/**
 * 微信小程序AccessToken
 *
 * @author futao
 * @date 2020/10/29
 */
@Slf4j
@Service
public class AccessTokenServiceImpl implements AccessTokenService {

    @Autowired
    private StringRedisTemplate redisTemplate;

    @Autowired
    private WxMiniProgramProperties wxMiniProgramProperties;

    /**
     * 获取token
     *
     * @return token
     */
    @Override
    public String get() {
        String redisAccessToken = redisTemplate.opsForValue().get(RedisKeyConsts.WxMiniProgram.WX_ACCESS_TOKEN);
        if (StringUtils.isBlank(redisAccessToken)) {
            //无缓存
            String url = UriComponentsBuilder
                    .fromHttpUrl(Consts.WxMiniProgram.WX_API_DOMAIN + "/cgi-bin/token")
                    .queryParam("grant_type", "client_credential")
                    .queryParam("appid", wxMiniProgramProperties.getAppId())
                    .queryParam("secret", wxMiniProgramProperties.getAppSecret())
                    .build()
                    .encode()
                    .toString();
            ResponseEntity<AccessToken> accessTokenResponseEntity = WxMiniProgramConfig.REST_TEMPLATE.getForEntity(url, AccessToken.class);
            AccessToken accessToken = accessTokenResponseEntity.getBody();
            String token = accessToken.getAccessToken();
            redisTemplate.opsForValue().set(RedisKeyConsts.WxMiniProgram.WX_ACCESS_TOKEN, token, accessToken.getExpiresIn() - 5, TimeUnit.SECONDS);
            return token;
        } else {
            // 缓存命中
            log.info("cache hint");
            return redisAccessToken;
        }
    }
}

想要请求的接口: GET https://api.weixin.qq.com/cgi-bin/message/wxopen/activityid/create?access_token=ACCESS_TOKEN&unionid=UNIONID

一、每个接口都手动拼上`accessToken`

/**
 * 动态消息
 *
 * @author futao
 * @date 2020/10/30
 */
@Service
public class DynamicMessageServiceImpl implements DynamicMessageService {

    @Autowired
    private AccessTokenService accessTokenService;

    /**
     * 创建被分享动态消息或私密消息的 activity_id
     *
     * @return
     */
    @Override
    public DynamicMessageCreateResult createActivityId() {
        String url = UriComponentsBuilder
                .fromHttpUrl(Consts.WxMiniProgram.WX_API_DOMAIN + "/cgi-bin/message/wxopen/activityid/create")
                // 手动加上请求参数accessToken
                .queryParam("access_token", accessTokenService.get())
                .build()
                .encode()
                .toString();
        ResponseEntity<DynamicMessageCreateResult> messageCreateResultResponseEntity = WxMiniProgramConfig.REST_TEMPLATE.getForEntity(url, DynamicMessageCreateResult.class);
        DynamicMessageCreateResult createResult = messageCreateResultResponseEntity.getBody();
        return createResult;
    }
}

测试

/**
 * @author futao
 * @date 2020/10/30
 */
@RequestMapping("/wx/mini")
@RestController
public class WxMiniController {

    @Autowired
    private DynamicMessageService dynamicMessageService;

    @GetMapping("/createDynamicMessage")
    public DynamicMessageCreateResult createDynamicMessage() {
        return dynamicMessageService.createActivityId();
    }
}

测试结果

功能是实现了，但是非常繁琐。

编码时，1.在每个调用微信小程序接口的地方，都加上accessToken参数，由于该参数又依赖于AccessTokenService，所以又需要先注入AccessTokenService，比较繁琐。且，2.如果固定的请求参数不止一个而有很多个，3.且来源比较复杂，将极大地增加开发的繁琐程度。且，4.如果后续参数有调整，有增减，那散落在各处的请求地址，每个都需要改，想想都可怕😨。

综合以上四点问题，迫切需要统一处理这些请求参数。

二、拦截RestTemplate请求地址，给请求地址添加参数并替换原有地址

RestTemplate拦截器


/**
 * @author futao
 * @date 2020/10/29
 */
@Slf4j
@Configuration
public class WxMiniProgramConfig {

    private static AccessTokenService ACCESS_TOKEN_SERVICE;

    /**
     * 忽略的Path的集合
     */
    private static final Set<String> IGNORE_PATH_SET = new HashSet<>();

    @Autowired
    private AccessTokenService accessTokenService;

    /**
     * PostConstruct注解的方法将会在依赖注入完成后被自动调用
     */
    @PostConstruct
    public void setWxMiniProgramProperties() {
        WxMiniProgramConfig.ACCESS_TOKEN_SERVICE = accessTokenService;
    }

    /**
     * 增强过的RestTemplate
     */
    public static final RestTemplate REST_TEMPLATE = new RestTemplate();

    static {
        //兼容text/plain
        WxMiniProgramConfig.REST_TEMPLATE.getMessageConverters()
                .add(new TextPlainHttpMessageConverter());
        //需要忽略的地址: 请求token
        IGNORE_PATH_SET.add("/cgi-bin/token");

        // 添加拦截器
        WxMiniProgramConfig.REST_TEMPLATE.getInterceptors().add(new ClientHttpRequestInterceptor() {
            @Override
            public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
                URI uri = request.getURI();
                // 原始请求参数
                String rawQueryString = uri.getRawQuery();
                if (!IGNORE_PATH_SET.contains(uri.getRawPath())) {
                    String queryStringToAppend = "access_token=" + WxMiniProgramConfig.ACCESS_TOKEN_SERVICE.get();
                    //追加之后的请求参数
                    String qsAfterAppend = StringUtils.isBlank(rawQueryString) ? queryStringToAppend : rawQueryString + "&" + queryStringToAppend;
                    try {
                        Field stringField = URI.class.getDeclaredField("string");
                        stringField.setAccessible(true);
                        // 完整请求路径
                        String completeUrl = uri.getScheme() + "://" + uri.getHost() + uri.getPath() + "?" + qsAfterAppend;
                        // 重新设置完整请求路径
                        stringField.set(uri, completeUrl);
                        log.debug("request complete url:{}", completeUrl);
                    } catch (NoSuchFieldException | IllegalAccessException e) {
                        log.error("反射异常", e);
                        throw new WxMiniProgramException("反射异常", e);
                    }
                } else {
                    log.debug("ignore path :{}", uri.getPath());
                }
                ClientHttpResponse httpResponse = execution.execute(request, body);
                if (!httpResponse.getStatusCode().is2xxSuccessful()) {
                    throw new WxMiniProgramException("访问微信小程序服务器失败:" + httpResponse.getStatusText());
                }
                return httpResponse;
            }
        });
    }

    /**
     * 兼容text/plain
     */
    static class TextPlainHttpMessageConverter extends MappingJackson2HttpMessageConverter {
        public TextPlainHttpMessageConverter() {
            ArrayList<MediaType> supportedMediaTypes = new ArrayList<>(1);
            supportedMediaTypes.add(MediaType.TEXT_PLAIN);
            this.setSupportedMediaTypes(supportedMediaTypes);
        }
    }
}

service不再需要手动拼接参数

替换字段 string的值，而不是字段 query，是因为debug后发现，最终请求的地址是 string这个字段的值。

测试

已自动加上了access_token

可以愉快地CRUD惹

三、其他

将拦截器封装成通用的方法

    /**
     * 追加请求参数queryString的拦截器
     *
     * @param paramsToAppend 需要追加的参数
     * @param ignorePathSet  忽略的path的集合
     * @return 拦截器
     */
    public static ClientHttpRequestInterceptor appendUrlQueryStringInterceptor(Map<String, Object> paramsToAppend, Set<String> ignorePathSet) {
        return (httpRequest, bytes, clientHttpRequestExecution) -> {
            if (paramsToAppend != null && paramsToAppend.size() > 0) {
                URI uri = httpRequest.getURI();
                // 未忽略
                if (ignorePathSet == null || (!ignorePathSet.contains(uri.getPath()))) {
                    //当前查询字符串
                    String rawQueryString = uri.getRawQuery();
                    StringBuffer sb = new StringBuffer();
                    paramsToAppend.forEach((k, v) -> sb.append(k)
                            .append("=")
                            .append(v)
                            .append("&"));
                    // 需要追加的queryString
                    String queryStringToAppend = sb.toString();
                    if (queryStringToAppend.endsWith("&")) {
                        queryStringToAppend = queryStringToAppend.substring(0, queryStringToAppend.lastIndexOf("&"));
                    }
                    //追加之后的请求参数
                    String qsAfterAppend = StringUtils.isBlank(rawQueryString) ? queryStringToAppend : rawQueryString + "&" + queryStringToAppend;
                    try {
                        Field stringField = URI.class.getDeclaredField("string");
                        stringField.setAccessible(true);
                        // 完整请求路径
                        String completeUrl = uri.getScheme() + "://" + uri.getHost() + uri.getPath() + "?" + qsAfterAppend;
                        stringField.set(uri, completeUrl);
                        log.debug("request complete url:{}", completeUrl);
                    } catch (NoSuchFieldException | IllegalAccessException e) {
                        log.error("反射异常", e);
                        throw new WxMiniProgramException("反射异常", e);
                    }
                }
            }
            ClientHttpResponse httpResponse = clientHttpRequestExecution.execute(httpRequest, bytes);
            if (!httpResponse.getStatusCode().is2xxSuccessful()) {
                throw new WxMiniProgramException("访问微信小程序服务器失败:" + httpResponse.getStatusText());
            }
            return httpResponse;
        };
    }

使用 setDefaultUriVariables()

欢迎在评论区留下你看文章时的思考，及时说出，有助于加深记忆和理解，还能和像你一样也喜欢这个话题的读者相遇~

本文分享自微信公众号 - 喜欢天文（AllUnderControl）。
如有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一起分享。

微信关注我们

原文链接：https://my.oschina.net/u/3529894/blog/4699094

转载内容版权归作者及来源网站所有！

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

machinery入门看这一篇（异步任务队列）

前言哈喽，大家好，我是asong，这次给大家介绍一个go的异步任务框架machinery。使用过python的同学们都知道Celery框架，machinery框架就类似于Celery框架。下面我们就来学习一下machinery的基本使用。自己翻译一个粗略版的machinery中文文档，有需要的伙伴们公众号自取无水印版：后台回复：machinery即可领取。或者github下载：https://github.com/asong2020/Golang_Dream/tree/master/machinery 抛砖引玉我们在使用某些APP时，登陆系统后一般会收到一封邮件或者一个短信提示我们在某个时间某某地点登陆了。而邮件或短信都是在我们已经登陆后才收到，这里就是采用的异步机制。大家有没有想过这里为什么没有使用同步机制实现呢？我们来分析一下。假设我们现在采用同步的方式实现，用户在登录时，首先会去检验一下账号密码是否正确，验证通过后去给用户发送登陆提示信息，假如在这一步出错了，那么就会导致用户登陆失败，这样是大大影响用户的体验感的，一个登陆提示的优先级别并不是很高，所以我们完全可以采用异步...

2020-10-31

445

前段时间，某同学说某服务的容器因为超出内存限制，不断地重启，问我们是不是有内存泄露，赶紧排查，然后解决掉，省的出问题。我们大为震惊，赶紧查看监控+报警系统和性能分析，发现应用指标压根就不高，不像有泄露的样子。问题到底是出在哪里了呢，我们进入某个容器里查看了 top 的系统指标： PIDVSZRSS...COMMAND674592007m136m..../eddycjy-server 看上去也没什么大开销的东西，就一个 Go 进程？就这？再定眼一看，某同学就说 VSZ 那么高，而某云上的容器内存指标居然恰好和 VSZ 的值相接近，因此就怀疑是不是 VSZ 所导致的，觉得存在一定的关联关系。这个猜测的结果到底是否正确呢？基础知识本篇文章将主要围绕 Go 进程的 VSZ 来进行剖析，看看到底它为什么那么 "高"。第一节为前置的补充知识，大家可按顺序阅读。什么是 VSZ VSZ 是该进程所能使用的虚拟内存总大小，它包括进程可以访问的所有内存，其中包括了被换出的内存（Swap）、已分配但未使用的内存以及来自共享库的内存。为什么要虚拟内存在前面我们有了解到 VSZ 其实就是该进...

2020-10-31

503

资源下载

更多资源

优质分享App

近一个月的开发和优化，本站点的第一个app全新上线。该app采用极致压缩，本体才4.36MB。系统里面做了大量数据访问、缓存优化。方便用户在手机上查看文章。后续会推出HarmonyOS的适配版本。

Mario

马里奥是站在游戏界顶峰的超人气多面角色。马里奥靠吃蘑菇成长，特征是大鼻子、头戴帽子、身穿背带裤，还留着胡子。与他的双胞胎兄弟路易基一起，长年担任任天堂的招牌角色。

Rocky Linux

Rocky Linux（中文名：洛基）是由Gregory Kurtzer于2020年12月发起的企业级Linux发行版，作为CentOS稳定版停止维护后与RHEL（Red Hat Enterprise Linux）完全兼容的开源替代方案，由社区拥有并管理，支持x86_64、aarch64等架构。其通过重新编译RHEL源代码提供长期稳定性，采用模块化包装和SELinux安全架构，默认包含GNOME桌面环境及XFS文件系统，支持十年生命周期更新。

Sublime Text

Sublime Text具有漂亮的用户界面和强大的功能，例如代码缩略图，Python的插件，代码段等。还可自定义键绑定，菜单和工具栏。Sublime Text 的主要功能包括：拼写检查，书签，完整的 Python API ， Goto 功能，即时项目切换，多选择，多窗口等等。Sublime Text 是一个跨平台的编辑器，同时支持Windows、Linux、Mac OS X等操作系统。