用于处理多个参数的 Grails rest-api 应用程序

Question

使用 Grails 3.1.3，我创建了一个 rest-api，以便我能够捕获 GET 请求，这些请求不仅可以查询一个参数，还可以在需要时获取多个参数。我不知道如何在 UrlMappings 文件中正确编码。以下是详细信息。

领域类：

class ProdDetail {
  Integer pid
  String title
  String category
  Integer year
}

其中一些在 BootStrap 中：

new ProdDetail(pid:'101', title:'No Highway', author:'Nevil Shute', category:'fiction', year:1948).save(failOnError:true)
new ProdDetail(pid:'214', title:'In the Country of Men', author:'Hisham Matar', category:'misery', year:2007).save(failOnError:true)

控制器：

protected List<ProdDetail> listAllResources(Map params) {

  println params

  try {
     ProdDetail.where {
        if (params.category && params.maxYear) {
           category == params.category && year <= params.int('maxYear')
        } else if (params.category) {
           category == params.category
        } else if (params.maxYear) {
           year <= params.int('maxYear')
        } else {
           pid > 0
        }
     }.list()
  } catch (Exception e) {
     []
  }
}

网址映射：

static mappings = {
   "/prodDetails"(resources:'prodDetail')
   "/prodDetails/category/$category?"(controller:'prodDetail', action:'index')
   "/prodDetails/yearUnder/$maxYear?"(controller:'prodDetail', action:'index')
   // the line below is not right I think, what's the correct format?
   "/prodDetails/combo/$category?&$maxYear?"(controller:'prodDetail', action:'index')
}

现在，这两个卷发在哪里起作用：

curl localhost:8080/prodDetails/category/misery
curl localhost:8080/prodDetails/yearUnder/2007

这一项未能进入控制器中所需的子句以检测两个参数：

curl localhost:8080/prodDetails/combo/?category=misery&maxYear=2007

它只检测到 'category' 而不是它认为是 'null' 的 'maxYear'。

请问这样的curl怎么办？

Answer 1

这取决于您希望您的 URL 看起来像什么，但假设您希望您的请求看起来像这样：

http://localhost:8080/prodDetails/combo/misery?maxYear=2007&title=common

UrlMappings 应该是这样的

static mappings = {
   "/prodDetails/combo/$category"(controller:'prodDetail', action:'index')
}

那么控制器中的params 对象应该同时具有$category 的位置，在这个例子中是痛苦的，以及? 之后的其他参数。

如果您希望参数位于路径中，您可以这样做：

static mappings = {
   "/prodDetails/combo/$category/$title/$maxYear"(controller:'prodDetail', action:'index')
}

然后请求将是：

http://localhost:8080/prodDetails/combo/misery/common/2007

另一种选择是使用命令对象。所以如果你有：

static mappings = {
   "/prodDetails/combosearch"(controller:'prodDetail', action:'comboSearch')
}

然后在控制器旁边创建了一个名为 ComboSearchCommand.groovy 的对象，如下所示：

import grails.validation.Validateable
class ComboSearchCommand implements Validetable {
    String category
    String title
    int maxYear

    static constraints = {
        category blank: false, nullable: true
        title blank: false, nullable: true
        maxYear blank: false, nullable: true
    }
}

（您可以像域对象一样对其进行验证）

然后在您的控制器中，您可以使用命令对象而不是参数的方法

protected List<ProdDetail> comboSearch(ComboSearchCommand command) {
    println command.category
}

那么你的网址就是

http://localhost:8080/prodDetails/combosearch?category=misery&maxYear=2007&title=common

并且参数会绑定到命令对象。

我已经使用了很多次，您可以共享验证或让您的命令对象从域对象继承验证，非常灵活。

https://grails.github.io/grails-doc/latest/guide/single.html#commandObjects

Answer 2

如果这些参数不是 URL 的一部分，则无需在 UrlMappings 中指定这些参数：

不需要这个：

"/prodDetails/combo/$category&?$maxYear?"(controller:'prodDetail', action:'index')

是的，您需要将 URL 与控制器/操作匹配（但删除 ?）

"/prodDetails/yearUnder/$maxYear?"(controller:'prodDetail', action:'index')

另外，您不需要 listAllResources(Map params) 中的 Map 参数

“params”是控制器的注入属性，println 参数可以正常工作：listAllResources()

我要做的是定义：

listAllResources(String category, int maxYear, ...) 其中 ... 是操作可以接收的所有参数，大多数是可选的，因此如果您的请求中未包含，您将收到一个空值。

记住：UrlMappings 是将 URL 映射到控制器/动作，并且您有相同的控制器/动作，所以我会删除所有映射并处理动作中的可选参数，只是检查哪些为空。

编辑（考虑 cmets）

问：该方法没有重载来处理这样的参数

A：方法是动态的，这是 Grails / Groovy，而不是 Java。即使所有参数都为空，它也会调用 action 方法。我建议您详细阅读 Grails 控制器文档。

问：发现listAllResources方法从来没有被调用过

A：从动作中删除受保护的关键字，只有子类才能调用该方法。此外，您可以添加一个 UrlMapping 以避免用户调用该 URL（匹配该 URL 并返回 404 Not Available 或类似的东西）

问：我想处理像 localhost:8080/prodDetails/combo?category=misery&year=2016&title=commonTitle 这样的 GET 请求，i) UrlMappings 中的条目和 ii) listAllResources 方法的外观应该如何喜欢吗？

答：

static mappings = {
   // if "compo" comes in the action portion, map that to the listAllResources method
   // as I said, if all parameters comes in the query string, no further actions are needed, if you need parameters to be part of the URL path, then you need to play with the $xxxx in the URL
   "/prodDetails/combo"(controller:'prodDetail', action:'listAllResources')
}

def listAllResources()
{
   println params
   // logic here
   render "OK"
}

检查：

• https://grails.github.io/grails-doc/latest/ref/Controllers/params.html
• https://grails.github.io/grails-doc/latest/ref/Controllers/render.html
• How does grails pass arguments to controller methods?