web-dev-qa-db-ja.com

'+'（プラス記号）は、文字列URLを使用してRestTemplateでエンコードされませんが、 ''（スペース）として解釈されます

Java 8からJava 11に、つまりSpring Boot 1.5.6から2.1.2に移動します。RestTemplateを使用すると、 '+'記号は '％2B'にエンコードされなくなりました（SPR-14828による変更）。RFC3986は '+'を予約文字としてリストしていないため、これは問題ありませんが、 ''として解釈されます（スペース）Spring Bootエンドポイントで受信された場合。

オプションのタイムスタンプをクエリパラメータとして取得できる検索クエリがあります。クエリはhttp://example.com/search?beforeTimestamp=2019-01-21T14:56:50%2B00:00のようになります。

二重にエンコードされていないと、エンコードされたプラス記号を送信する方法を理解できません。クエリパラメータ2019-01-21T14:56:50+00:00は2019-01-21T14:56:50 00:00として解釈されます。パラメータを自分でエンコードする場合（2019-01-21T14:56:50%2B00:00）、それを受け取って2019-01-21T14:56:50%252B00:00として解釈します。

追加の制約は、クエリが実行されている場所ではなく、restTemplateを設定するときに、ベースURLを別の場所に設定することです。

または、エンドポイントによって「+」が「」と解釈されないようにする方法はありますか？

コメントとして説明されている欠点を伴う、より厳密なエンコーディングを実現するいくつかの方法を示す短い例を書きました：

package com.example.clientandserver;

import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.DefaultUriBuilderFactory;
import org.springframework.web.util.UriComponentsBuilder;
import org.springframework.web.util.UriUtils;

import Java.nio.charset.StandardCharsets;
import Java.util.HashMap;
import Java.util.Map;

@SpringBootApplication
@RestController
public class ClientAndServerApp implements CommandLineRunner {

    public static void main(String[] args) {
        SpringApplication.run(ClientAndServerApp.class, args);
    }

    @Override
    public void run(String... args) {
        String beforeTimestamp = "2019-01-21T14:56:50+00:00";

        // Previously - base url and raw params (encoded automatically). 
        // This worked in the earlier version of Spring Boot
        {
            RestTemplate restTemplate = new RestTemplateBuilder()
               .rootUri("http://localhost:8080").build();
            UriComponentsBuilder b = UriComponentsBuilder.fromPath("/search");
            if (beforeTimestamp != null) {
                b.queryParam("beforeTimestamp", beforeTimestamp);
            }
            restTemplate.getForEntity(b.toUriString(), Object.class);
            // Received: 2019-01-21T14:56:50 00:00
            //       Plus sign missing here ^
        }

        // Option 1 - no base url and encoding the param ourselves.
        {
            RestTemplate restTemplate = new RestTemplate();
            UriComponentsBuilder b = UriComponentsBuilder
                .fromHttpUrl("http://localhost:8080/search");
            if (beforeTimestamp != null) {
                b.queryParam(
                    "beforeTimestamp",
                    UriUtils.encode(beforeTimestamp, StandardCharsets.UTF_8)
                );
            }
            restTemplate.getForEntity(
                b.build(true).toUri(), Object.class
            ).getBody();
            // Received: 2019-01-21T14:56:50+00:00
        }

        // Option 2 - with templated base url, query parameter is not optional.
        {
            RestTemplate restTemplate = new RestTemplateBuilder()
                .rootUri("http://localhost:8080")
                .uriTemplateHandler(new DefaultUriBuilderFactory())
                .build();
            Map<String, String> params = new HashMap<>();
            params.put("beforeTimestamp", beforeTimestamp);
            restTemplate.getForEntity(
                "/search?beforeTimestamp={beforeTimestamp}",
                Object.class,
                params);
            // Received: 2019-01-21T14:56:50+00:00
        }
    }

    @GetMapping("/search")
    public void search(@RequestParam String beforeTimestamp) {
        System.out.println("Received: " + beforeTimestamp);
    }
}
javaspringspring-boottimestamprfc3986
20
Gregor Eesmaa

この問題もここで議論されています。

RestTemplateでのURI変数のエンコード[SPR-16202]

より簡単な解決策は、URIビルダーのエンコードモードをVALUES_ONLYに設定することです。

    DefaultUriBuilderFactory builderFactory = new DefaultUriBuilderFactory();
    builderFactory.setEncodingMode(DefaultUriBuilderFactory.EncodingMode.VALUES_ONLY);
    RestTemplate restTemplate = new RestTemplateBuilder()
            .rootUri("http://localhost:8080")
            .uriTemplateHandler(builderFactory)
            .build();

これにより、クエリパラメータを使用するときにPlusEncodingInterceptorを使用した場合と同じ結果が得られました。

0
Matt Garner