当相对 URI 包含空路径时,Java 的 URI.resolve 是否与 RFC 3986 不兼容?

2022-09-04 03:01:21

我相信Java的URI.resolve方法的定义和实现与RFC 3986第5.2.2节不兼容。我知道Java API定义了该方法的工作原理,如果现在更改它,它将破坏现有的应用程序,但我的问题是:任何人都可以确认我的理解,即此方法与RFC 3986不兼容?

我使用这个问题中的示例:java.net.URI 仅针对查询字符串进行解析,我将将其复制到此处:


我正在尝试使用JDK java.net.URI构建URI。我想追加到一个绝对URI对象,一个查询(在字符串中)。例如:

URI base = new URI("http://example.com/something/more/long");
String queryString = "query=http://local:282/rand&action=aaaa";
URI query = new URI(null, null, null, queryString, null);
URI result = base.resolve(query);

理论(或我认为)是决心应该回归:

http://example.com/something/more/long?query=http://local:282/rand&action=aaaa

但我得到的是:

http://example.com/something/more/?query=http://local:282/rand&action=aaaa

我对 RFC 3986 第 5.2.2 节的理解是,如果相对 URI 的路径为空,则将使用基本 URI 的整个路径:

        if (R.path == "") then
           T.path = Base.path;
           if defined(R.query) then
              T.query = R.query;
           else
              T.query = Base.query;
           endif;

并且仅当指定了路径时,才是要与基本路径合并的相对路径:

        else
           if (R.path starts-with "/") then
              T.path = remove_dot_segments(R.path);
           else
              T.path = merge(Base.path, R.path);
              T.path = remove_dot_segments(T.path);
           endif;
           T.query = R.query;
        endif;

但是Java实现总是进行合并,即使路径为空:

    String cp = (child.path == null) ? "" : child.path;
    if ((cp.length() > 0) && (cp.charAt(0) == '/')) {
      // 5.2 (5): Child path is absolute
      ru.path = child.path;
    } else {
      // 5.2 (6): Resolve relative path
      ru.path = resolvePath(base.path, cp, base.isAbsolute());
    }

如果我的阅读是正确的,为了从RFC伪代码中获取此行为,您可以在查询字符串之前在相对URI中放置一个点作为路径,根据我使用相对URI作为网页中链接的经验,这是我所期望的:

transform(Base="http://example.com/something/more/long", R=".?query")
    => T="http://example.com/something/more/?query"

但是,我希望在网页中,页面上“http://example.com/something/more/long”到“?query”的链接将转到“http://example.com/something/more/long?query”,而不是“http://example.com/something/more/?query” - 换句话说,与RFC一致,但与Java实现不一致。

我对RFC的解读是否正确,而Java方法与它不一致,还是我遗漏了什么?


答案 1

是的,我同意 URI.resolve(URI) 方法与 RFC 3986 不兼容。最初的问题本身就提出了大量的研究,有助于得出这一结论。首先,让我们澄清任何困惑。

正如Raedwald所解释的那样(在现已删除的答案中),以以下结尾的基本路径之间存在区别:/

  • fizz相对于是:/foo/bar/foo/fizz
  • fizz相对于是:/foo/bar//foo/bar/fizz

虽然正确,但这不是一个完整的答案,因为原始问题不是询问路径(即上面的“嘶嘶声”)。相反,问题与相对 URI 引用的单独查询组件有关。示例代码中使用的 URI 类构造函数接受五个不同的 String 参数,并且除参数外的所有参数都作为 传递。(请注意,Java接受空字符串作为路径参数,这在逻辑上会导致“空”路径组件,因为“路径组件永远不会未定义”,尽管它“可能是空的(零长度)”。这在以后会很重要。queryStringnull

之前的评论中,Sajan Chandran指出,java.net.URI被记录用于实现RFC 2396而不是问题的主题RFC 3986。前者于2005年被后者汰。URI类Javadoc没有提到较新的RFC,这可以被解释为其不兼容的更多证据。让我们再堆一些:

  • JDK-6791060 是一个开放性问题,它建议此类“应针对 RFC 3986 进行更新”。那里的注释警告“RFC3986与2396不完全向后兼容”。

  • 以前曾尝试更新 URI 类的某些部分以使其符合 RFC 3986(如 JDK-6348622),但随后又回滚破坏向后兼容性。(另请参阅 JDK 邮件列表上的此讨论

  • 尽管路径“合并”逻辑听起来很相似,如 SubOptimal 所述,但在较新的 RFC 中指定的伪代码与实际实现不匹配。在伪代码中,当相对 URI 的路径为时,将从基 URI 按原样复制生成的目标路径。在这些条件下不执行“合并”逻辑。与该规范相反,Java的URI实现在最后一个字符之后修剪了基本路径,如问题中所示。/

如果需要 RFC 3986 行为,可以使用 URI 类的替代方法。Java EE 6 实现提供了 javax.ws.rs.core.UriBuilder,它(在 Jersey 1.18 中)的行为似乎符合您的预期(见下文)。就编码不同的URI组件而言,它至少声称对RFC的认识。

在 J2EE 之外,Spring 3.0 引入了 UriUtils,专门用于“基于 RFC 3986 的编码和解码”。Spring 3.1弃用了其中的一些功能,并引入了UriComponentsBuilder,但不幸的是,它没有记录对任何特定RFC的遵守情况。


测试程序,演示不同的行为:

import java.net.*;
import java.util.*;
import java.util.function.*;
import javax.ws.rs.core.UriBuilder; // using Jersey 1.18

public class StackOverflow22203111 {

    private URI withResolveURI(URI base, String targetQuery) {
        URI reference = queryOnlyURI(targetQuery);
        return base.resolve(reference);
    }
 
    private URI withUriBuilderReplaceQuery(URI base, String targetQuery) {
        UriBuilder builder = UriBuilder.fromUri(base);
        return builder.replaceQuery(targetQuery).build();
    }

    private URI withUriBuilderMergeURI(URI base, String targetQuery) {
        URI reference = queryOnlyURI(targetQuery);
        UriBuilder builder = UriBuilder.fromUri(base);
        return builder.uri(reference).build();
    }

    public static void main(String... args) throws Exception {

        final URI base = new URI("http://example.com/something/more/long");
        final String queryString = "query=http://local:282/rand&action=aaaa";
        final String expected =
            "http://example.com/something/more/long?query=http://local:282/rand&action=aaaa";

        StackOverflow22203111 test = new StackOverflow22203111();
        Map<String, BiFunction<URI, String, URI>> strategies = new LinkedHashMap<>();
        strategies.put("URI.resolve(URI)", test::withResolveURI);
        strategies.put("UriBuilder.replaceQuery(String)", test::withUriBuilderReplaceQuery);
        strategies.put("UriBuilder.uri(URI)", test::withUriBuilderMergeURI);

        strategies.forEach((name, method) -> {
            System.out.println(name);
            URI result = method.apply(base, queryString);
            if (expected.equals(result.toString())) {
                System.out.println("   MATCHES: " + result);
            }
            else {
                System.out.println("  EXPECTED: " + expected);
                System.out.println("   but WAS: " + result);
            }
        });
    }

    private URI queryOnlyURI(String queryString)
    {
        try {
            String scheme = null;
            String authority = null;
            String path = null;
            String fragment = null;
            return new URI(scheme, authority, path, queryString, fragment);
        }
        catch (URISyntaxException syntaxError) {
            throw new IllegalStateException("unexpected", syntaxError);
        }
    }
}

输出:

URI.resolve(URI)
  EXPECTED: http://example.com/something/more/long?query=http://local:282/rand&action=aaaa
   but WAS: http://example.com/something/more/?query=http://local:282/rand&action=aaaa
UriBuilder.replaceQuery(String)
   MATCHES: http://example.com/something/more/long?query=http://local:282/rand&action=aaaa
UriBuilder.uri(URI)
   MATCHES: http://example.com/something/more/long?query=http://local:282/rand&action=aaaa

答案 2

如果你想要更好的1 行为,并且不想在你的程序中包含另一个大的依赖项2,那么我发现下面的代码在我的要求中运行良好:URI.resolve()

public URI resolve(URI base, URI relative) {
    if (Strings.isNullOrEmpty(base.getPath()))
        base = new URI(base.getScheme(), base.getAuthority(), "/",
            base.getQuery(), base.getFragment());
    if (Strings.isNullOrEmpty(uri.getPath()))
        uri = new URI(uri.getScheme(), uri.getAuthority(), base.getPath(),
            uri.getQuery(), uri.getFragment());
    return base.resolve(uri);
}

唯一的非JDK的东西来自番石榴,为了可读性 - 如果你没有番石榴,请用你自己的1行方法替换。Strings

脚注:

  1. 我不能说这里的简单代码示例符合RFC3986。
  2. 例如Spring,javax.ws 或 - 如本答案所述 - Apache HTTPClient。