如何从类型为“application/json”的 CFFUNCTION 创建输出？

Question

我有一个 cfc，它创建一个包含 JSON 的输出字符串。有效负载很好，但接收它的人告诉我数据是以 text/html 形式传入的，而他的程序无法将其识别为有效，因为它需要是 application/json。

因此，我修改了 CFFUNCTION 语句中的参数，并构建了一个小型测试程序，其中显示：

 <cffunction name="Test" httpmethod="get" returntype="JSON" output="yes" access="remote">
    <cfset JSON='{"Test": "A"}'>
    <cfreturn JSON>
    </cffunction>

但是，当我远程执行此 cfc 时，收到错误消息“测试函数返回的值不是 JSON 类型”。

这应该很容易，但我不知道需要做什么才能返回具有 application/json 类型的 JSON 字符串。

Answer 1

你的第一个问题是returntype="JSON"- 看起来你很困惑returntype并且returnformat. 有多种方法可以实现您想要做的事情，例如，每种方法都会返回相同的结果：

<!--- Function returns a struct, ask CF to convert it to JSON using returnformat: --->
<cffunction name="Test2" returntype="struct" returnformat="JSON" output="false" access="remote">
    <cfset var myStruct={"Test"="A", "foo"="bar"} />
    <cfreturn myStruct />
</cffunction>

<!--- Function uses a struct, but serializes as a JSON string before returning --->
<cffunction name="Test3" returntype="string" returnformat="plain" output="false" access="remote">
    <cfset var myStruct={"Test"="A", "foo"="bar"} />
    <cfreturn SerializeJSON(myStruct)>
</cffunction>

<!--- Same as above but another variation of struct notation. 
    Note that most CF environments will convert unquoted key names to uppercase 
    unless you enable serialization.preserveCaseForStructKey at application or CF Admin level --->
<cffunction name="Test4" returntype="string" returnformat="plain" output="false" access="remote">
    <cfset var myStruct=structNew() />
    <cfset myStruct['Test'] = "A" />
    <cfset myStruct['foo'] = "bar" />
    <cfreturn SerializeJSON(myStruct) />
</cffunction>

<!--- Manually build the JSON string yourself from scratch, beware of encoding/escaping issues --->
<cffunction name="Test5" returntype="string" returnformat="plain" output="false" access="remote">
    <cfset var myJSONString='{"Test":"A","foo":"bar"}' />
    <cfreturn myJSONString />
</cffunction>

请注意，仅上述内容不会将内容类型响应标头设置为application/json，如果您的调用者实际上关心这一点，那么您将需要类似以下内容： <cfheader name="Content-Type" value="application/json; charset=utf-8" /> ...但是The value returned from the Test function is not of type JSON您引用的错误是 CF 运行时错误，而不是浏览器/阿贾克斯错误。该错误的全文通常是：

The value returned from the Test function is not of type JSON. If the component name is specified as a return type, it is possible that either a definition file for the component cannot be found or is not accessible.