ngx.req.set_uri_args 的使用陷阱

ngx.req.set_uri_args 是一个在Nginx的Lua模块（通常是 OpenResty ）中使用的函数，这个函数可以用来动态修改请求的查询字符串（Query String），但某些情况下，原始请求的 Query 参数顺序经过这个函数修改后可能会改变参数顺序。

1. 基础用法

1.1 传递table参数

• 设置 URI 参数为 “?arg1=value1”

ngx.req.set_uri_args({ arg1 = "value1" })

• 设置 URI 参数为 “?arg1=value1&arg2=value2”

ngx.req.set_uri_args({ arg1 = "value1", arg2 = "value2" })

1.2 传递字符串

• 可以直接传递一个编码后的查询字符串，URI 参数会被设置为 “?arg1=value1&arg2=value2”

ngx.req.set_uri_args("arg1=value1&arg2=value2")

1.3 数组参数

• 设置 URI 参数为 “?arg=value1&arg=value2”

ngx.req.set_uri_args({ arg = {"value1", "value2" } })

2. 需要注意的陷阱

2.1 参数顺序

在Lua中，字典（或哈希表）的遍历顺序是不确定的，因为它们是根据键的哈希值来组织的，而不是按照插入的顺序，当使用 ngx.req.set_uri_args 函数设置参数时，参数若被存储在一个表（Lua中的数组和字典结构）里，在 ngx.req.set_uri_args 函数中参数被转回URI字符串时，它们的顺序可能与原始或预期的顺序不同。例如，

ngx.req.set_uri_args({ arg1 = "value1", arg2 = "value2", arg3 = "value3"})

设置完 URI 参数可能会变为 “arg3=value3&arg2=value2&arg1=value1”。

2.2 URL 编码问题

ngx.req.set_uri_args 函数在设置 URI 参数时，会自动对参数执行URL编码，调用前不需要事先对参数值进行编码。当传递一个 Lua 表或键值对参数到该函数时，它会确保所有的参数值被正确地编码为适合在 URL 中使用的格式。

例如，如果有包含（如空格、&、% 等）的参数值时，ngx.req.set_uri_args 会将这些字符串转换为他们的 URL 编码形式，这是处理 HTTP 请求的标准做法，确保了数据的完整性和传输的安全性。

ngx.req.set_uri_args({ arg = "value with space" })

这个例子中，参数 “arg” 的值 “value with spaces” 中的空格会被转换为 “%20” 。如果直接传递一个已经编码的查询字符串给 “ngx.req.set_uri_args” ，它将不会再次对这个字符串进行编码。所以，在这种情况下，需要确保提供的字符串已经正确编码。

这个例子中，参数 “arg” 的值 “value with spaces” 中的空格会被转换为"%20" 。如果直接传递一个已经编码的查询字符串给 “ngx.req.set_uri_args” ，它将不会再次对这个字符串进行编码。所以，在这种情况下使用函数时，需要确保提供的字符串已经正确编码。

有些 http 请求中一般不编码的符号例如冒号，通过 table 参数传递给 ngx.req.set_uri_args 时，也会被编码，但直接传递字符串不会被 URL 编码，例如以下两种传递字符串的方式设置后的 URI 参数是不同的。

ngx.req.set_uri_args({arg1 = "2001:4860:4801:48::13"})
通过 table 设置后 uri 参数为 arg1=2001%3A4860%3A4801%3A48%3A%3A13

ngx.req.set_uri_args("arg1=2001:4860:4801:48::13")
通过 字符串 设置后 uri 参数为 arg1=2001:4860:4801:48::13

综上所示，ngx.req.set_uri_args 使用时需要注意查询字符串中的参数顺序和编码是否符合预期。

欢迎来公众号交流，共同学习，共同进步，分享总结 C++、Golang、数据结构等面试考点，日常工作经验等等，持续更新！