如何确定 CFC 函数内的 ReturnFormat 并以所选格式返回数据？

Question

我正在 CFScript 中编写以下函数，我想确定请求的 ReturnFormat，并以适当的格式返回数据。请注意，我根本没有在函数中定义 ReturnFormat - 我依赖于在调用中设置它。

例如，调用此函数的 URL 类似于： http://localhost/com/Calendar.cfc?method=getCalendars&UserName=demo&returnFormat=json

/**
* 
* @hint Returns All Calendar records for one user.
* @output false
*/
remote any function GetCalendars(required string Username) {
    var data = [];
    var success = false;
    var message = "";

    try {
        query = new Query(); 
        query.setDataSource(APPLICATION.DSN);
        query.addParam(name = "username", value = Username, cfsqltype = "varchar");
        query.setSQL("
            SELECT idn, CalendarName, CalendarURL, CalendarColor
            FROM Calendars
            WHERE Username = :username 
            ORDER BY CalendarName, idn
        ");
        result = query.Execute();
        rs = result.getResult();
        success = true;
        message = "Success";
        records = rs.RecordCount;
    }
    catch (any excpt) {
        success = false;
        message = "An error occurred while getting calendars for user: " & Username;
    }
    finally {
        //TODO: If ReturnFormat = json, return a JSON string
        //TODO: If ReturnFormat = wddx, returna WDDX object
        //TODO: If ReturnFormat = plain, return an XML string
        return rs;
    }
} //end GetCalendars

现在，此方法将返回 ColdFusion 自动格式化的 JSON 字符串，如下所示：

{"COLUMNS":["IDN","CALENDARNAME","CALENDARURL","CALENDARCOLOR"],"DATA":[[1,"演示 日历 1","http:\/\/localhost\/calendar\/feeds\/demo1\/basic","#43cd80"],[2,"演示 日历 2","http:\/\/localhost\/calendar\/feeds\/demo2\/basic","#9a9cff"]]}

或者像这样的 WDDX 对象：

<记录集 rowCount='2' fieldNames='IDN,CALENDARNAME,CALENDARURL,CALENDARCOLOR' type='coldfusion.sql.QueryTable'><字段 name='IDN'><数字>1.0<数字>2.0<字段 name='CALENDARNAME'>演示日历 1演示 日历 2http:\/\/localhost\/calendar\/feeds\/demo1\/basichttp:\/\/localhost\/calendar\/ feed\/demo2\/basic#43cd80#9a9cff

但当我设置时，它失败并出现“无效返回类型”错误returnFormat=plain。

基本上我需要一种方法来测试 ReturnFormat。然后我可以编写自己的返回子例程，以按照我想要的方式返回 JSON 数据（小写名称任何人！-我知道如何做到这一点，顺便说一句，这不是这个问题的一部分）并以 XML 格式返回。

Answer 1

您不会检测 returnFormat 或对其执行任何操作。这不是重点。 returnFormat 告诉 CF 它应该如何包装你的结果。重复：你不用担心这个。时期。

因此，给出一个创建数组的 CFC 方法，您只需返回该数组。 CF，如果看到 returnformat=json，将处理将其转换为 JSON。

如果它看到 returnformat=plain，它将抛出一个错误（因为数组不能是纯字符串）。

这有道理吗？

哦 - 所以我看到你的最后一段。如果您想尝试自己进行退货，则不应依赖退货格式。这已被烘焙到 CF 中。我将构建我的 api，使其始终返回 JSON、句点，并进行您自己的格式化。如果在方法上设置 returnFOrmat=plain，它会告诉 CF 不要执行任何操作。只要返回一个字符串就可以了。