programing

'+'(더하기 기호)가 문자열 URL을 사용하여 RestTemplate로 인코딩되지 않고 '(스페이스)'로 해석됩니다.

powerit 2023. 3. 9. 22:23
반응형

'+'(더하기 기호)가 문자열 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.

이중 부호화 없이는 부호화된 플러스 기호를 보낼 수 없습니다.Query 파라미터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);
    }
}

인코딩이 완료된 후 대행 수신기에서 URL을 수정할 수 있다는 것을 알게 되었습니다.따라서 쿼리 매개 변수에서 더하기 기호를 인코딩하는 가로채기를 사용하는 것이 해결책입니다.

RestTemplate restTemplate = new RestTemplateBuilder()
        .rootUri("http://localhost:8080")
        .interceptors(new PlusEncoderInterceptor())
        .build();

예를 들어 다음과 같습니다.

public class PlusEncoderInterceptor implements ClientHttpRequestInterceptor {

    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        return execution.execute(new HttpRequestWrapper(request) {
            @Override
            public URI getURI() {
                URI u = super.getURI();
                String strictlyEscapedQuery = StringUtils.replace(u.getRawQuery(), "+", "%2B");
                return UriComponentsBuilder.fromUri(u)
                        .replaceQuery(strictlyEscapedQuery)
                        .build(true).toUri();
            }
        }, body);
    }
}

그 문제는 여기서도 논의되었다.

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();

이를 통해 Plus Encoding을 사용하는 경우와 동일한 결과를 얻을 수 있습니다.쿼리 매개 변수를 사용하는 경우 인터셉터.

https://stackoverflow.com/users/4466695/gregor-eesmaa, 덕분에 문제가 해결되었습니다.전화하기 전에 URL 형식을 지정할 수 있다면 추가하려고 합니다.RestTemplateURL을 한 번에 수정할 수 있습니다(로 치환하지 않고).PlusEncoderInterceptor):

UriComponentsBuilder uriBuilder = UriComponentsBuilder.fromUriString("/search");
uriBuilder.queryParam("beforeTimestamp", "2019-01-21T14:56:50+00:00");
URI uriPlus = uriBuilder.encode().build(false).toUri();

// import org.springframework.util.StringUtils;
String strictlyEscapedQuery = StringUtils.replace(uriPlus.getRawQuery(), "+", "%2B");
URI uri = UriComponentsBuilder.fromUri(uriPlus)
        .replaceQuery(strictlyEscapedQuery)
        .build(true).toUri();

// prints "/search?beforeTimestamp=2019-01-21T14:56:50%2B00:00"
System.out.println(uri);

그럼 다음에서 사용할 수 있습니다.RestTemplate호출:

RequestEntity<?> requestEntity = RequestEntity.get(uri).build();
ResponseEntity<String> responseEntity = restTemplate.exchange(requestEntity, String.class);

이런 문제를 피하기 위해 URI를 직접 만드는 것이 더 쉬웠다.

URI uri = new URI(siteProperties.getBaseUrl()
  + "v3/elements/"
  + URLEncoder.encode("user/" + user + "/type/" + type, UTF_8)
  + "/"
  + URLEncoder.encode(id, UTF_8)
);

restTemplate.exchange(uri, DELETE, new HttpEntity<>(httpHeaders), Void.class);

추가만 하면 됩니다.프로젝트에서 RestTemplate를 사용한 곳마다 설정을 하지 않아도 됩니다.config는 UTF-8 인코딩 응답도 지원합니다.

public class PlusEncoderInterceptor implements ClientHttpRequestInterceptor {

@Override
public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution)
        throws IOException {
    return execution.execute(new HttpRequestWrapper(request) {
        @NotNull
        @Override
        public URI getURI() {
            URI u = super.getURI();
            String strictlyEscapedQuery = StringUtils.replace(u.getRawQuery(), "+", "%2B");
            return UriComponentsBuilder.fromUri(u).replaceQuery(strictlyEscapedQuery).build(true).toUri();
        }
    }, body);
}
}

@Configuration
public class RestTemplateConfig {
@Bean
public RestTemplate restTemplate() {
    RestTemplate restTemplate = new RestTemplateBuilder().interceptors(new PlusEncoderInterceptor()).build();
    restTemplate.getMessageConverters().add(0, new StringHttpMessageConverter(StandardCharsets.UTF_8));
    return restTemplate;
}
}

언급URL : https://stackoverflow.com/questions/54294843/plus-sign-not-encoded-with-resttemplate-using-string-url-but-interpreted

반응형