Skip to content

[SCB-2790]CseUriTemplateHandler implements DefaultUriBuilderFactory i… #3771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liubao68 merged 2 commits into from
May 6, 2023
Merged

[SCB-2790]CseUriTemplateHandler implements DefaultUriBuilderFactory i… #3771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9854e3e
[SCB-2790]CseUriTemplateHandler implements DefaultUriBuilderFactory i…
liubao68 May 5, 2023
7a85bbb
[SCB-2790]fix unit test fail and behavior change
liubao68 May 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions .../src/main/java/org/apache/servicecomb/demo/jaxrs/client/TestQueryParamWithListSchema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,19 @@ private void testCSVRest() {
}

private void testSSV() {
TestMgr.check("2:[1, 2]",
TestMgr.check("1:[1%202]",
restTemplate.getForObject("cse://jaxrs/queryList/queryListSSV?queryList=1%202", String.class));
TestMgr.check("2:[, ]",
TestMgr.check("1:[%20]",
restTemplate.getForObject("cse://jaxrs/queryList/queryListSSV?queryList=%20", String.class));
TestMgr.check("1:[]",
restTemplate.getForObject("cse://jaxrs/queryList/queryListSSV?queryList=", String.class));

TestMgr.check("2:[1, 2]",
restTemplate.getForObject("cse://jaxrs/queryList/queryListSSV?queryList={1}", String.class, "1 2"));
TestMgr.check("2:[, ]",
restTemplate.getForObject("cse://jaxrs/queryList/queryListSSV?queryList={1}", String.class, " "));
TestMgr.check("1:[]",
restTemplate.getForObject("cse://jaxrs/queryList/queryListSSV?queryList=", String.class));
}

private void testTSVHighway() {
Expand Down
8 changes: 8 additions & 0 deletions ...springmvc-client/src/main/java/org/apache/servicecomb/demo/springmvc/SpringmvcClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,14 @@ private static void testControllerRest(RestTemplate template, String microservic
template.getForObject(prefix + "/controller/sayhi?name=world",
String.class));

TestMgr.check("hi world boot [world boot]",
template.getForObject(prefix + "/controller/sayhi?name=world boot",
String.class));

TestMgr.check("hi world boot [world boot]",
template.getForObject(prefix + "/controller/sayhi?name=world+boot",
String.class));

TestMgr.check("hi world1 [world1]",
template.getForObject(prefix + "/controller/sayhi?name={name}",
String.class,
Expand Down
9 changes: 8 additions & 1 deletion ...c/main/java/org/apache/servicecomb/provider/springmvc/reference/CseClientHttpRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
import org.apache.servicecomb.core.provider.consumer.InvokerUtils;
import org.apache.servicecomb.core.provider.consumer.MicroserviceReferenceConfig;
import org.apache.servicecomb.core.provider.consumer.ReferenceConfig;
import org.apache.servicecomb.registry.definition.DefinitionConst;
import org.apache.servicecomb.swagger.invocation.Response;
import org.apache.servicecomb.swagger.invocation.context.InvocationContext;
import org.apache.servicecomb.swagger.invocation.exception.ExceptionFactory;
Expand Down Expand Up @@ -177,7 +178,7 @@ public ClientHttpResponse execute() {
}

protected RequestMeta createRequestMeta(String httpMethod, URI uri) {
String microserviceName = uri.getAuthority();
String microserviceName = parseMicroserviceName(uri);

MicroserviceReferenceConfig microserviceReferenceConfig = SCBEngine.getInstance()
.createMicroserviceReferenceConfig(microserviceName);
Expand All @@ -200,6 +201,12 @@ protected RequestMeta createRequestMeta(String httpMethod, URI uri) {
return new RequestMeta(referenceConfig, swaggerRestOperation, pathParams);
}

private String parseMicroserviceName(URI uri) {
String microserviceName = uri.getAuthority();
return microserviceName.replace(CseUriTemplateHandler.APP_SERVICE_SEPARATOR_INTERNAL,
DefinitionConst.APP_SERVICE_SEPARATOR);
}

protected String findUriPath(URI uri) {
return uri.getRawPath();
}
Expand Down
156 changes: 20 additions & 136 deletions .../main/java/org/apache/servicecomb/provider/springmvc/reference/CseUriTemplateHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,158 +17,42 @@
package org.apache.servicecomb.provider.springmvc.reference;

import java.net.URI;
import java.net.URISyntaxException;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.servicecomb.common.rest.RestConst;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.web.util.UriComponents;
import org.springframework.web.util.UriComponentsBuilder;
import org.apache.servicecomb.registry.definition.DefinitionConst;
import org.springframework.web.util.DefaultUriBuilderFactory;

/**
* 默认不支持下面第1个场景，需要做出修正
* cse://app:ms/path to cse://app/ms/path
* cse://ms/path to cse://ms/path
*/
@SuppressWarnings("deprecation")
// TODO : upgrade to spring 5 will having warning's , we'll fix it later
public class CseUriTemplateHandler extends org.springframework.web.util.DefaultUriTemplateHandler {
private static final String SCHEME_PATTERN = "([^:/?#]+):";

private static final String USERINFO_PATTERN = "([^@\\[/?#]*)";

private static final String HOST_IPV4_PATTERN = "[^\\[/?#:]*";

private static final String HOST_IPV6_PATTERN = "\\[[\\p{XDigit}:.]*[%\\p{Alnum}]*]";

private static final String HOST_PATTERN = "(" + HOST_IPV6_PATTERN + "|" + HOST_IPV4_PATTERN + ")";

private static final String PORT_PATTERN = "(\\d*(?:\\{[^/]+?})?)";

private static final String PATH_PATTERN = "([^?#]*)";

private static final String QUERY_PATTERN = "([^#]*)";

private static final String LAST_PATTERN = "(.*)";

// Regex patterns that matches URIs. See RFC 3986, appendix B
private static final Pattern URI_PATTERN = Pattern.compile(
"^(" + SCHEME_PATTERN + ")?" + "(//(" + USERINFO_PATTERN + "@)?" + HOST_PATTERN + "(:" + PORT_PATTERN +
")?" + ")?" + PATH_PATTERN + "(\\?" + QUERY_PATTERN + ")?" + "(#" + LAST_PATTERN + ")?");
public class CseUriTemplateHandler extends DefaultUriBuilderFactory {
public static final String APP_SERVICE_SEPARATOR_INTERNAL = ".";

public CseUriTemplateHandler() {
setStrictEncoding(true);
}

@Override
protected URI expandInternal(String uriTemplate, Map<String, ?> uriVariables) {
UriComponentsBuilder uriComponentsBuilder = initUriComponentsBuilder(uriTemplate);
UriComponents uriComponents = expandAndEncode(uriComponentsBuilder, uriVariables);
return createUri(uriTemplate, uriComponents);
public URI expand(String uriTemplate, Map<String, ?> uriVars) {
return super.expand(parseUrl(uriTemplate), uriVars);
}

@Override
protected URI expandInternal(String uriTemplate, Object... uriVariables) {
UriComponentsBuilder uriComponentsBuilder = initUriComponentsBuilder(uriTemplate);
UriComponents uriComponents = expandAndEncode(uriComponentsBuilder, uriVariables);
return createUri(uriTemplate, uriComponents);
public URI expand(String uriTemplate, Object... uriVars) {
return super.expand(parseUrl(uriTemplate), uriVars);
}

@Override
protected UriComponentsBuilder initUriComponentsBuilder(String uriTemplate) {
UriComponentsBuilder builder = fromUriString(uriTemplate);
if (shouldParsePath() && !isStrictEncoding()) {
List<String> pathSegments = builder.build().getPathSegments();
builder.replacePath(null);
for (String pathSegment : pathSegments) {
builder.pathSegment(pathSegment);
}
private static String parseUrl(String uriTemplate) {
int indexSchema = -1;
if (uriTemplate.startsWith(RestConst.URI_PREFIX)) {
indexSchema = RestConst.URI_PREFIX.length();
}
return builder;
}

private static UriComponentsBuilder fromUriString(String uri) {
Assert.notNull(uri, "URI must not be null");
Matcher matcher = URI_PATTERN.matcher(uri);
if (matcher.matches()) {
UriComponentsBuilder builder = UriComponentsBuilder.newInstance();
String scheme = matcher.group(2);
String userInfo = matcher.group(5);
String host = matcher.group(6);
String port = matcher.group(8);
String path = matcher.group(9);
String query = matcher.group(11);
String fragment = matcher.group(13);
boolean opaque = false;
if (StringUtils.hasLength(scheme)) {
String rest = uri.substring(scheme.length());
if (!rest.startsWith(":/")) {
opaque = true;
}
}
builder.scheme(scheme);
if (opaque) {
String ssp = uri.substring(scheme.length()).substring(1);
if (StringUtils.hasLength(fragment)) {
ssp = ssp.substring(0, ssp.length() - (fragment.length() + 1));
}
builder.schemeSpecificPart(ssp);
} else {
builder.userInfo(userInfo);
builder.host(host);
if (StringUtils.hasLength(port)) {
builder.port(port);
}
builder.path(path);
builder.query(query);
}
if (StringUtils.hasText(fragment)) {
builder.fragment(fragment);
}
return builder;
} else {
throw new IllegalArgumentException("[" + uri + "] is not a valid URI");
if (uriTemplate.startsWith(RestConst.URI_PREFIX_NEW)) {
indexSchema = RestConst.URI_PREFIX_NEW.length();
}
}

private URI createUri(String uriTemplate, UriComponents uriComponents) {
String strUri = uriComponents.toUriString();

Matcher matcher = URI_PATTERN.matcher(uriTemplate);
matcher.matches(); // should always be true
String scheme = matcher.group(2);
String host = matcher.group(6);

if (isCrossApp(uriTemplate, scheme, host)) {
int idx;
if (RestConst.SCHEME.equals(scheme)) {
idx = strUri.indexOf('/', RestConst.URI_PREFIX.length());
} else {
idx = strUri.indexOf('/', RestConst.URI_PREFIX_NEW.length());
}
strUri = strUri.substring(0, idx) + ":" + strUri.substring(idx + 1);
if (indexSchema != -1) {
int indexPath = uriTemplate.indexOf("/", indexSchema);
String host = uriTemplate.substring(indexSchema, indexPath);
host = host.replace(DefinitionConst.APP_SERVICE_SEPARATOR, APP_SERVICE_SEPARATOR_INTERNAL);
return uriTemplate.substring(0, indexSchema) + host + uriTemplate.substring(indexPath);
}

try {
// Avoid further encoding (in the case of strictEncoding=true)
return new URI(strUri);
} catch (URISyntaxException ex) {
throw new IllegalStateException("Could not create URI object: " + ex.getMessage(), ex);
}
}

private boolean isCrossApp(String uriTemplate, String scheme, String host) {
int pos;
if (RestConst.SCHEME.equals(scheme)) {
pos = RestConst.URI_PREFIX.length() + host.length();
} else {
pos = RestConst.URI_PREFIX_NEW.length() + host.length();
}

return uriTemplate.charAt(pos) == ':';
return uriTemplate;
}
}
21 changes: 19 additions & 2 deletions ...t/java/org/apache/servicecomb/provider/springmvc/reference/TestCseUriTemplateHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,33 @@ public class TestCseUriTemplateHandler {
public void testCrossApp() {
CseUriTemplateHandler handler = new CseUriTemplateHandler();
URI uri = handler.expand("cse://{ap}{p}:ms/{path}?q={query}", "ap", "p", "path", "query");
Assertions.assertEquals("cse://app:ms/path?q=query", uri.toString());
Assertions.assertEquals("cse://app.ms/path?q=query", uri.toString());

Map<String, String> vars = new HashMap<>();
vars.put("app", "app");
vars.put("path", "path");
vars.put("q", "query");
uri = handler.expand("cse://{app}:ms/{path}?q={q}", vars);
Assertions.assertEquals("cse://app:ms/path?q=query", uri.toString());
Assertions.assertEquals("cse://app.ms/path?q=query", uri.toString());

uri = handler.expand("cse://ms/{path}?q={query}", "path", "query");
Assertions.assertEquals("cse://ms/path?q=query", uri.toString());
}

@Test
public void testCrossAppServiceComb() {
CseUriTemplateHandler handler = new CseUriTemplateHandler();
URI uri = handler.expand("servicecomb://{ap}{p}:ms/{path}?q={query}", "ap", "p", "path", "query");
Assertions.assertEquals("servicecomb://app.ms/path?q=query", uri.toString());

Map<String, String> vars = new HashMap<>();
vars.put("app", "app");
vars.put("path", "path");
vars.put("q", "query");
uri = handler.expand("servicecomb://{app}:ms/{path}?q={q}", vars);
Assertions.assertEquals("servicecomb://app.ms/path?q=query", uri.toString());

uri = handler.expand("servicecomb://ms/{path}?q={query}", "path", "query");
Assertions.assertEquals("servicecomb://ms/path?q=query", uri.toString());
}
}