1

我正在 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,"Demo Calendar 1","http:\/\/localhost\/calendar\/feeds\/demo1\/basic","#43cd80"],[2,"Demo Calendar 2","http:\/\/localhost\/calendar\/feeds\/demo2\/basic","#9a9cff"]]}

或者像这样的 WDDX 对象：

<wddxPacket version='1.0'><header/><data><recordset rowCount='2' fieldNames='IDN,CALENDARNAME,CALENDARURL,CALENDARCOLOR' type='coldfusion.sql.QueryTable'><field name='IDN'><number>1.0</number><number>2.0</number></field><field name='CALENDARNAME'><string>Demo Calendar 1</string><string>Demo Calendar 2</string></field><field name='CALENDARURL'><string>http:\/\/localhost\/calendar\/feeds\/demo1\/basic</string><string>http:\/\/localhost\/calendar\/feeds\/demo2\/basic</string></field><field name='CALENDARCOLOR'><string>#43cd80</string><string>#9a9cff</string></field></recordset></data></wddxPacket>

但是当我设置returnFormat=plain.

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

4

1 回答 1

2

您不会检测或使用 returnFormat 做任何事情。那不是重点。returnFormat 告诉 CF 它应该如何包装你的结果。重复：你不用担心这个。时期。

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

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

这有意义吗？

哦-所以我看到了你的最后一段。如果你想尝试自己做 return，你不应该依赖 returnformat。这已经融入了 CF。我将构建我的 api 以始终返回 JSON、句点并进行自己的格式化。如果您在该方法上设置 returnFOrmat=plain，它会告诉 CF 不做任何事情。只要你返回一个字符串，那么你就可以了。

于 2011-12-29T01:39:45.430 回答