Spire 天擎

外观

class HttpResponse ​

cangjie
public abstract class HttpResponse

功能：表示 HTTP 响应。

成员概览 ​

成员功能
prop statusCode获取或修改响应状态码。
prop contentType获取或修改响应内容类型。
prop contentLength获取或修改响应内容长度。
prop body返回响应正文流。
prop cookies返回响应 Cookie 集合。
prop headers返回响应头集合。
prop httpContext返回所属的 HTTP 上下文。
prop hasStarted检查响应是否已开始发送。
func write(Array<Byte>)向响应正文写入字节数组。
func onStarting(() -> Unit)注册响应开始前执行的回调。
func onCompleted(() -> Unit)注册响应完成后执行的回调。

prop statusCode ​

cangjie
public mut prop statusCode: UInt16

功能：获取或修改响应状态码。

类型：UInt16

prop contentType ​

cangjie
public mut prop contentType: ?String

功能：获取或修改响应内容类型。

类型：?String

prop contentLength ​

cangjie
public mut prop contentLength: ?Int64

功能：获取或修改响应内容长度。

类型：?Int64

prop body ​

cangjie
public prop body: IOStream

功能：返回响应正文流。

类型：IOStream

prop cookies ​

cangjie
public prop cookies: IResponseCookies

功能：返回响应 Cookie 集合。

类型：IResponseCookies

prop headers ​

cangjie
public prop headers: IHeaderDictionary

功能：返回响应头集合。

类型：IHeaderDictionary

prop httpContext ​

cangjie
public prop httpContext: HttpContext

功能：返回所属的 HTTP 上下文。

类型：HttpContext

prop hasStarted ​

cangjie
public prop hasStarted: Bool

功能：检查响应是否已开始发送。

类型：Bool

func write(Array<Byte>) ​

cangjie
public func write(bytes: Array<Byte>): Unit

功能：向响应正文写入字节数组。

参数：

  • bytes: Array<Byte> - 要写入的字节数据。

返回值：

  • Unit

func onStarting(() -> Unit) ​

cangjie
public func onStarting(callback: () -> Unit): Unit

功能：注册响应开始前执行的回调。

参数：

  • callback: () -> Unit - 响应开始前执行的回调函数。

返回值：

  • Unit

func onCompleted(() -> Unit) ​

cangjie
public func onCompleted(callback: () -> Unit): Unit

功能：注册响应完成后执行的回调。

参数：

  • callback: () -> Unit - 响应完成后执行的回调函数。

返回值：

  • Unit

扩展成员 ​

成员功能
func registerForDispose(Resource)注册在响应完成后释放的资源。
func write(String)向响应正文写入字符串内容。
func redirect(String)将响应重定向到指定位置。
func writeAsJson(T)将数据作为 JSON 写入响应。
func writeAsJson(T, JsonSerializerOptions)使用指定选项将数据作为 JSON 写入响应。

func registerForDispose(Resource) ​

cangjie
public func registerForDispose(resource: Resource): Unit

功能：注册在响应完成后释放的资源。

参数：

  • resource: Resource - 响应完成后需要关闭的资源。

返回值：

  • Unit

func write(String) ​

cangjie
public func write(text: String): Unit

功能：向响应正文写入字符串内容。

参数：

  • text: String - 要写入的字符串内容。

返回值：

  • Unit

func redirect(String) ​

cangjie
public func redirect(location: String): Unit

功能：将响应重定向到指定位置。

参数：

  • location: String - 重定向目标地址。

返回值：

  • Unit

func writeAsJson(T) ​

cangjie
public func writeAsJson<T>(data: T): Unit

功能：将数据作为 JSON 写入响应。

参数：

  • data: T - 要序列化并写入的数据。

返回值：

  • Unit

异常：

  • UnsupportedException - 当数据类型不支持 JSON 写入时抛出。

func writeAsJson(T, JsonSerializerOptions) ​

cangjie
public func writeAsJson<T>(data: T, options: JsonSerializerOptions): Unit

功能：使用指定选项将数据作为 JSON 写入响应。

参数：

返回值：

  • Unit

异常：

  • UnsupportedException - 当数据类型不支持 JSON 写入时抛出。