如何在 Ruby 中对字符串进行 URL 编码

Question

如何 URI::encode 一个字符串，如：

\x12\x34\x56\x78\x9a\xbc\xde\xf1\x23\x45\x67\x89\xab\xcd\xef\x12\x34\x56\x78\x9a

格式获取它

%124Vx%9A%BC%DE%F1%23Eg%89%AB%CD%EF%124Vx%9A

以按照 RFC 1738 的

？这是我尝试过的：

irb(main):123:0> URI::encode "\x12\x34\x56\x78\x9a\xbc\xde\xf1\x23\x45\x67\x89\xab\xcd\xef\x12\x34\x56\x78\x9a"
ArgumentError: invalid byte sequence in UTF-8
    from /usr/local/lib/ruby/1.9.1/uri/common.rb:219:in `gsub'
    from /usr/local/lib/ruby/1.9.1/uri/common.rb:219:in `escape'
    from /usr/local/lib/ruby/1.9.1/uri/common.rb:505:in `escape'
    from (irb):123
    from /usr/local/bin/irb:12:in `<main>'

另外：

irb(main):126:0> CGI::escape "\x12\x34\x56\x78\x9a\xbc\xde\xf1\x23\x45\x67\x89\xab\xcd\xef\x12\x34\x56\x78\x9a"
ArgumentError: invalid byte sequence in UTF-8
    from /usr/local/lib/ruby/1.9.1/cgi/util.rb:7:in `gsub'
    from /usr/local/lib/ruby/1.9.1/cgi/util.rb:7:in `escape'
    from (irb):126
    from /usr/local/bin/irb:12:in `<main>'

我查遍了互联网，但还没有找到一种方法来做到这一点，尽管我几乎肯定前几天我做到了这一点，没有任何麻烦。

Answer 1

str = "\x12\x34\x56\x78\x9a\xbc\xde\xf1\x23\x45\x67\x89\xab\xcd\xef\x12\x34\x56\x78\x9a".force_encoding('ASCII-8BIT')
puts CGI.escape str


=> "%124Vx%9A%BC%DE%F1%23Eg%89%AB%CD%EF%124Vx%9A"

Answer 2

现在，您应该使用 ERB::Util.url_encode 或 CGI.escape。它们之间的主要区别在于它们对空格的处理：

>> ERB::Util.url_encode("foo/bar? baz&")
=> "foo%2Fbar%3F%20baz%26"

>> CGI.escape("foo/bar? baz&")
=> "foo%2Fbar%3F+baz%26"

CGI.escape 遵循 CGI/HTML 表单规范 并为您提供一个 application/x-www-form-urlencoded 字符串，该字符串需要将空格转义为+，而 ERB::Util.url_encode 遵循 RFC 3986，要求将它们编码为 %20。

请参阅“URI.escape 和CGI.escape？”以获取更多讨论。

Answer 3

str = "\x12\x34\x56\x78\x9a\xbc\xde\xf1\x23\x45\x67\x89\xab\xcd\xef\x12\x34\x56\x78\x9a"
require 'cgi'
CGI.escape(str)
# => "%124Vx%9A%BC%DE%F1%23Eg%89%AB%CD%EF%124Vx%9A"

摘自@J-Rou 的评论

Answer 4

我最初试图从完整的 URL 字符串中仅转义文件名中的特殊字符，而不是路径上的特殊字符。

ERB::Util.url_encode 不适用于我的使用：

helper.send(:url_encode, "http://example.com/?a=\11\15")
# => "http%3A%2F%2Fexample.com%2F%3Fa%3D%09%0D"

基于“https://stackoverflow.com/questions/34274838/why-is-uri-escape-marked-as”中的两个答案-obsolete-and-where-is-this-regexpunsafe-constant”，看起来 URI::RFC2396_Parser#escape 比使用更好URI::Escape#escape。然而，它们对我的行为都是一样的：

URI.escape("http://example.com/?a=\11\15")
# => "http://example.com/?a=%09%0D"
URI::Parser.new.escape("http://example.com/?a=\11\15")
# => "http://example.com/?a=%09%0D"

更新：我认为它来自 Ruby 3.0，URI.escape 不再起作用。除了 URI::Parser.new.escape 之外，我还没有找到替代品。

Answer 5

您可以使用 Addressable::URI gem 来实现：

require 'addressable/uri'   
string = '\x12\x34\x56\x78\x9a\xbc\xde\xf1\x23\x45\x67\x89\xab\xcd\xef\x12\x34\x56\x78\x9a'
Addressable::URI.encode_component(string, Addressable::URI::CharacterClasses::QUERY)
# "%5Cx12%5Cx34%5Cx56%5Cx78%5Cx9a%5Cxbc%5Cxde%5Cxf1%5Cx23%5Cx45%5Cx67%5Cx89%5Cxab%5Cxcd%5Cxef%5Cx12%5Cx34%5Cx56%5Cx78%5Cx9a" 

它使用比 CGI.escape 更现代的格式，例如，它正确地将空格编码为 %20< /code> 而不是 + 符号，您可以在“维基百科上的 application/x-www-form-urlencoded 类型”。

2.1.2 :008 > CGI.escape('Hello, this is me')
 => "Hello%2C+this+is+me" 
2.1.2 :009 > Addressable::URI.encode_component('Hello, this is me', Addressable::URI::CharacterClasses::QUERY)
 => "Hello,%20this%20is%20me" 

Answer 6

代码：

str = "http://localhost/with spaces and spaces"
encoded = URI::encode(str)
puts encoded

结果：

http://localhost/with%20spaces%20and%20spaces

Answer 7

我创建了一个 gem 来使 URI 编码内容更清晰，以便在代码中使用。它会为您处理二进制编码。

运行gem install uri-handler，然后使用：

require 'uri-handler'

str = "\x12\x34\x56\x78\x9a\xbc\xde\xf1\x23\x45\x67\x89\xab\xcd\xef\x12\x34\x56\x78\x9a".to_uri
# => "%124Vx%9A%BC%DE%F1%23Eg%89%AB%CD%EF%124Vx%9A"

它将 URI 转换功能添加到 String 类中。您还可以向它传递一个带有您想要使用的可选编码字符串的参数。默认情况下，如果直接 UTF-8 编码失败，它会设置为编码“二进制”。

Answer 8

如果您想“编码”完整的 URL，而不必考虑手动将其拆分为不同的部分，我发现以下方法的工作方式与我过去使用 URI.encode 的方式相同：

URI.parse(my_url).to_s