路由上下文概要

之前文档所使用的iris.Context源代码可以找到这里({$goPath}\github.com\kataras\iris\context\context.go)。使用IDE /编辑器auto-complete功能将对您有所帮助。我们这里对context里的方法进行剖析(了解)

  1. package context
  2. type Context interface {
  3.     // BeginRequest 针对每一个请求都会执行
  4.     // 它应该为新的请求准备(新的或从pool获得的)上下文的字段。
  6.     // 要跟随iris的流程，开发人员应:
  7.     // 1. 重置handler 为nil
  8.     // 2. 重置 values 为空
  9.     // 3. 重置会话为 nil
  10.     // 4. 重置 response writer 到 http.ResponseWriter
  11.     // 5. 重置 request 到 *http.Request
  12.     // 任何其他可选步骤都取决于开发的应用程序类型。
  13.     BeginRequest(http.ResponseWriter, *http.Request)
  15.     // 在请求被响应以后 执行EndRequest，并且这个请求的上下文变为无效或者已经释放
  16.     // 要跟随iris的流程，开发人员应:
  17.     // 1.刷新响应编写器的结果
  18.     // 2.刷新响应编写器的结果
  19.     // 任何其他可选步骤都取决于开发的应用程序类型。
  20.     EndRequest()
  22.     //ResponseWriter按预期返回与http.ResponseWriter兼容的响应编写器。
  23.     ResponseWriter() ResponseWriter
  25.     // 改变或者升级ResponseWriter.
  26.     ResetResponseWriter(ResponseWriter)
  28.     // 按预期返回原始的* http.Request。
  29.     Request() *http.Request
  31.     // SetCurrentRouteName在内部设置路由的名称，
  32.     //为了能够找到正确的当前“只读”路由时
  33.     // end-developer调用`GetCurrentRoute（）`函数。
  34.     //如果您更改了该名称，它将由路由器初始化,他只会更改当名称
  35.     // 通过`GetCurrentRoute（）`您将会得到所更改的名称。
  37.     //相反，要执行不同的路径
  38.     //你应该使用`Exec`函数
  39.     //或通过`SetHandlers 或者 AddHandler`函数更改处理程序。
  40.     SetCurrentRouteName(currentRouteName string)
  42.     // GetCurrentRoute返回当前注册的“只读”路由
  43.     //正在注册此请求的路径。
  44.     //r:=ctx.GetCurrentRoute()//获取当前路由
  45.     //fmt.Println(r)//输出:GET /users/{id:int}/profile
  46.     GetCurrentRoute() RouteReadOnly
  48.     //调用  SetHandlers(handlers)
  49.     // 并且执行该方法所设置的第一个handlers
  50.     // handlers 不应该为空.
  51.     // 这是路由器使用的 开发者应该使用exex(Handler)直接调用要执行的handler
  52.     Do(Handlers)
  54.     // AddHandler可以添加处理程序
  55.     //到服务时间的当前请求，
  56.     //这些处理程序没有持久化到路由器。
  57.     //路由器正在调用此函数来添加路由的处理程序。
  58.     //如果调用了AddHandler，则会插入处理程序
  59.     //到已经定义的路由处理程序的末尾。
  60.     //ctx.Handlers()[1](ctx)//调用当前添加的函数1为当前handler再handlers数组中的下标
  61.     //再当前被添加的函数中使用ctx.HandlerIndex(2)定义该函数的位置
  62.     AddHandler(...Handler)
  64.     //SetHandlers用新的 handler取代所有处理程序。
  65.     SetHandlers(Handlers)
  67.     //返回当前所有的可调用的handler。
  68.     Handlers() Handlers
  70.     // 设置当前hander 在handeler数组中的下标位置返回-1代表ok
  71.     // Look Handlers(), Next() and StopExecution() too.
  72.     HandlerIndex(n int) (currentIndex int)
  74.     // Proceed 是检查特定处理程序是否已被执行并在其中调用`ctx.Next`函数的另一种方法
  75.     // 只有在内部运行处理程序时，这才有用
  76.     // 另一个处理它只是在索引和after索引之前检查。
  78.     // 一个使用实例就是去执行一个中间件
  79.     // 在控制器的`BeginRequest`中调用其中的`ctx.Next`。
  80.     // Controller查看整个流程（BeginRequest，方法处理程序，EndRequest） 作为一个处理程序，
  81.     // 所以`ctx.Next`不会反映到方法处理程序中
  82.     // 如果从`BeginRequest`调用。
  83.     //
  84.     // 虽然`BeginRequest`不应该用于调用其他处理程序，
  85.     //引入了`BeginRequest`以便能够设置 执行前所有方法处理程序的公共数据。
  86.     // 控制器可以正常接受来自MVC的应用程序路由器的中间件。
  87.     // 让我们看一个`ctx.Proceed`的例子：
  88.     // var authMiddleware = basicauth.New(basicauth.Config{
  89.     //         Users: map[string]string{
  90.     //             "admin": "password",
  91.     //         },
  92.     // })
  93.     // func (c *UsersController) BeginRequest(ctx iris.Context) {
  94.     //     if !ctx.Proceed(authMiddleware) {
  95.     //         ctx.StopExecution()
  96.     //      }
  97.     // }
  98.     //这个Get（）将在与`BeginRequest`相同的处理程序中执行，
  99.     //内部控制器检查`ctx.StopExecution`。
  100.     //因此，如果BeginRequest调用了`StopExecution`，它将不会被触发。
  101.     // func(c *UsersController) Get() []models.User {
  102.     //      return c.Service.GetAll()
  103.     // }
  104.     // 另一种方法是`！ctx.IsStopped（）`如果中间件在失败时使用`ctx.StopExecution（）`。
  105.     Proceed(Handler) bool
  107.     // HandlerName返回当前处理程序的名称，有助于调试。格式package.function
  108.     HandlerName() string
  110.     / Next从处理程序链中调用所有下一个处理程序,
  111.     //它应该在中间件中使用
  112.     //注意：自定义上下文应该重写此方法，以便能够传递自己的context.Context实现。
  113.     Next()
  114.     // NextOr检查链是否有下一个处理程序，如果是，则执行它
  115.     //否则它根据给定的处理程序设置分配给此Context的新链
  116.     //并执行其第一个处理程序。
  118.     //如果存在并执行下一个处理程序，则返回true，否则返回false
  119.     //请注意，如果找不到下一个处理程序，则缺少处理程序
  120.     //它向客户端发送未找到状态（404）并停止执行。
  121.     NextOr(handlers ...Handler) bool
  123.     // NextOrNotFound检查链是否有下一个处理程序，如果是，则执行它
  124.     //否则它会向客户端发送未找到状态（404）并停止执行。
  125.     //如果存在并执行下一个处理程序，则返回true，否则返回false
  126.     NextOrNotFound() bool
  128.     // NextHandler从处理程序链返回（它不执行）下一个处理程序。
  129.     //如果需要执行下一个返回处理程序，请使用.Skip（）跳过此处理程序。
  130.     NextHandler() Handler
  131.     //跳过/忽略处理程序链中的下一个处理程序，
  132.     //它应该在中间件中使用
  133.     Skip()
  134.      //终止当前程序但不是退出（等于设定一个终止标记）
  135.     //如果调用StopExecution，则调用以下.Next调用被忽略，
  136.     //因此链中的下一个处理程序不会被触发。
  137.     StopExecution()
  139.     // IsStopped检查并在Context的当前位置为255时返回true，
  140.     //表示调用了StopExecution（）
  141.     IsStopped() bool
  143.     // 请求参数介绍
  144.     // Params返回当前url的命名参数键值存储。
  145.     //这里保存了命名路径参数。
  146.     //作为整个Context，此存储是按请求生存期。
  147.     Params() *RequestParams
  149.     /值返回当前的“用户”存储。
  150.     //可以在此处保存命名路径参数和任何可选数据。
  151.     //作为整个Context，此存储是按请求生存期。
  152.     //您可以使用此函数来设置和获取本地值
  153.     //可用于在处理程序和中间件之间共享信息。
  154.     Values() *memstore.Store
  156.     //翻译是i18n（本地化）中间件的功能，
  157.     //它调用Get（“translate”）来返回翻译的值。
  158.     //示例：https：//github.com/kataras/iris/tree/master/_examples/miscellaneous/i18n
  159.     Translate(format string, args ...interface{}) string
  160.     //  +------------------------------------------------------------+
  161.     //  |路径,主机,子域,IP,标头等...              |
  162.     //  +------------------------------------------------------------+
  163.     // 返回request.Method，客户端的http方法返回给服务器
  164.     Method() string
  166.     // Path返回完整的请求路径，/name 不包含host 和请求参数
  167.    //如果EnablePathEscape配置字段为true，则进行转义。 
  168.     Path() string
  170.     // RequestPath返回完整的请求路径
  171.     //基于'escape'。
  172.     RequestPath(escape bool) string
  174.     // Host返回当前url的主机部分。如localhost
  175.     Host() string
  177.     // Subdomain返回此请求的子域（如果有）。
  178.     //请注意，这是一种不能涵盖所有情况的快速方法。
  179.     Subdomain() (subdomain string)
  181.     //如果当前子域（如果有）是www，则IsWWW返回true。
  182.     IsWWW() bool
  184.     / RemoteAddr尝试解析并返回真实客户端的请求IP。
  185.     //基于可从Configuration.RemoteAddrHeaders修改的允许标头名称。
  186.     //如果基于这些头的解析失败，那么它将返回Request的`RemoteAddr`字段
  187.     //在HTTP处理程序之前由服务器填充。
  189.     //查看  `Configuration.WithRemoteAddrHeader(...)`,
  190.     //      `Configuration.WithoutRemoteAddrHeader(...)` for more.
  191.     RemoteAddr() string
  193.     // GetHeader根据名称返回请求标头的值。
  194.     GetHeader(name string) string
  196.     //如果此请求是'ajax请求'（XMLHttpRequest），则IsAjax返回true
  197.     //没有100％的方式知道请求是通过Ajax进行的。
  198.     //您永远不应该信任来自客户端的数据，可以通过欺骗轻松克服这些数据。
  200.     //注意“X-Requested-With”标题可以被任何客户端修改（因为“X-”），
  201.     //所以不要依赖IsAjax来做真正严肃的事情，
  202.     //尝试找到另一种检测类型的方法（即内容类型），
  203.     //有很多博客描述这些问题并提供不同类型的解决方案，
  204.     //它始终取决于您正在构建的应用程序，
  205.     //这就是为什么这个'IsAjax``足够简单以便通用的原因。
  206.     //阅读更多信息：
  207.     IsAjax() bool
  209.     // IsMobile会检查客户端是否正在使用移动设备（手机或平板电脑）与此服务器通信。
  210.     //如果返回值为true，则表示http客户端使用移动设备
  211.     //设备与服务器通信，否则为false。
  212.     //请注意，这会检查“User-Agent”请求标头。
  213.     IsMobile() bool
  214.     //  +------------------------------------------------------------+
  215.     //  |响应头助手                                   |
  216.     //  +------------------------------------------------------------+
  217.     // 添加一个响应头
  218.     Header(name string, value string)
  220.     //设置响应头 "Content-Type" to the 'cType'.
  221.     ContentType(cType string)
  223.     // GetContentType返会响应头 “Content-Type”
  224.     //可以使用'ContentType'设置之前。
  225.     GetContentType() string
  227.     // GetContentLength 返回请求头 "Content-Length". 的值
  228.     //当改值没有找到或者不是一个数字 将会返回0
  229.     GetContentLength() int64
  231.     // StatusCode 设置响应的statu code 值
  233.     StatusCode(statusCode int)
  235.     //返回响应的当前状态代码。
  236.     GetStatusCode() int
  238.     //重定向向客户端发送重定向响应
  239.     //到特定网址或相对路径。
  240.     //接受2个参数字符串和一个可选的int
  241.     //第一个参数是要重定向的URL
  242.     //第二个参数是应该发送的http状态，
  243.     //默认为302（StatusFound），
  244.     //你可以将它设置为301（Permant重定向）
  245.     //或303（StatusSeeOther）如果POST方法，
  246.     //或StatusTemporaryRedirect（307），如果这是nessecery。
  247.     Redirect(urlToRedirect string, statusHeader ...int)
  248.     //  +------------------------------------------------------------+
  249.     //  | 各种请求和Post数据                            |
  250.     //  +------------------------------------------------------------+
  251.     // URLParam 如果url参数存在，则返回true，否则返回false。
  252.     URLParamExists(name string) bool
  254.     // URLParamDefault返回请求中的get参数，
  255.     //如果没有找到 则返回 设定的 "def".
  256.     URLParamDefault(name string, def string) string
  258.     //URLParam返回请求中的get参数（如果有）。
  259.     URLParam(name string) string
  261.     // 返回url查询参数，其中从请求中删除了尾随空格。
  262.     URLParamTrim(name string) string
  264.     // URLParamTrim 从请求中返回转义的url查询参数。URLParamEscape（名称字符串）字符串
  265.     URLParamEscape(name string) string
  267.     // URLParamInt将url查询参数作为来自请求的int值返回，
  268.     //返回-1，如果解析失败则返回错误。
  269.     URLParamInt(name string) (int, error)
  271.     //将url查询参数作为来自请求的int值返回，
  272.     //如果找不到或解析失败，则返回 设定的 "def".
  273.     URLParamIntDefault(name string, def int) int
  275.     // URLParamInt64 将url查询参数作为来自请求的int64值返回,
  276.     //返回-1，如果解析失败则返回错误。
  277.     URLParamInt64(name string) (int64, error)
  279.     // URLParamInt64Default  将url查询参数作为来自请求的int64值返回,
  280.     //如果找不到或解析失败，则返回 设定的 "def".
  281.     URLParamInt64Default(name string, def int64) int64
  283.     // URLParamFloat64 将url查询参数作为来自请求的float64值返回,
  284.     //返回-1，如果解析失败则返回错误。
  285.     URLParamFloat64(name string) (float64, error)
  287.     // URLParamFloat64Default  将url查询参数作为来自请求的float64值返回,
  288.     //如果找不到或解析失败，则返回 设定的 "def".
  289.     URLParamFloat64Default(name string, def float64) float64
  290.     // URLParamFloat64 将url查询参数作为来自请求的bool值返回,
  291.     //返回-1，如果解析失败则返回错误。
  293.     URLParamBool(name string) (bool, error)
  295.     // URLParams返回由逗号分隔的GET查询参数的映射（如果有多个）
  296.     //如果找不到任何内容，则返回空map。
  298.     URLParams() map[string]string
  300.     // FormValueDefault通过其"名称"返回单个解析的表单值,
  301.     //包括URL字段的查询参数和POST或PUT表单数据。
  302.     //如果没有找到返回设定的def
  303.     FormValueDefault(name string, def string) string
  305.     // FormValue通过其“名称”返回单个解析的表单值，
  306.     //包括URL字段的查询参数和POST或PUT表单数据。
  307.     FormValue(name string) string
  309.     // FormValues返回已解析的表单数据，包括URL
  310.     //字段的查询参数和POST或PUT表单数据。
  312.     //默认表单的内存最大大小为32MB，可以通过更改
  313.     //在主要配置中的`iris＃WithPostMaxMemory`配置器传递给`app.Run`的第二个参数。
  315.     //注意：需要检查nil。
  316.     FormValues() map[string][]string
  318.     // PostValueDefault从POST，PATCH返回解析后的表单数据
  319.     //或基于“名称”的PUT身体参数。
  320.    //如果没有找到返回设定的def
  321.     // If not found then "def" is returned instead.
  322.     PostValueDefault(name string, def string) string
  324.     // PostValue从POST，PATCH返回解析后的表单数据
  325.     //或基于“名称”的PUT身体参数
  326.     PostValue(name string) string
  328.     // PostValueTrim从POST，PATCH返回解析后的表单数据
  329.     //或PUT基于“名称”的体参数，没有尾随空格。
  330.     PostValueTrim(name string) string
  332.     // PostValueInt从POST，PATCH返回解析后的表单数据
  333.     //或PUT基于“名称”的体参数，如int。
  335.     //如果未找到则返回-1并返回非nil错误。
  336.     PostValueInt(name string) (int, error)
  338.     // PostValueIntDefault从POST，PATCH返回解析后的表单数据
  339.     //或PUT基于“名称”的体参数，如int
  341.     //如果没有找到返回设定的def
  342.     PostValueIntDefault(name string, def int) int
  344.     // PostValueInt64从POST，PATCH返回解析后的表单数据，
  345.     //或PUT基于“名称”的体参数，如float64。
  346.     // 如果未找到则返回-1并返回非nil错误。
  347.      PostValueInt64(name string) (int64, error)
  349.     // PostValueInt64Default从POST，PATCH返回解析后的表单数据，
  350.     //或PUT基于“名称”的体参数，如int64。
  351.     //如果没有找到返回设定的def
  352.     PostValueInt64Default(name string, def int64) int64
  354.     // PostValueFloat64从POST，PATCH返回解析后的表单数据，
  355.     //或PUT基于“名称”的体参数，如float64。
  356.     // 如果未找到则返回-1并返回非nil错误。
  357.     PostValueFloat64(name string) (float64, error)
  358.     // PostValueInt64Default从POST，PATCH返回解析后的表单数据，
  359.     //或PUT基于“名称”的体参数，如Int64。
  360.     //如果没有找到返回设定的def
  361.     PostValueFloat64Default(name string, def float64) float64
  363.     // PostValueInt64Default从POST，PATCH返回解析后的表单数据，
  364.     //或PUT基于“名称”的身体参数，如bool。
  366.     //如果未找到或value为false，则返回false，否则返回true。
  367.     PostValueBool(name string) (bool, error)
  369.     // PostValues从POST，PATCH返回所有已解析的表单数据，
  370.     //或PUT体参数基于“名称”作为字符串切片。
  371.     //
  372.     //默认表单的内存最大大小为32MB，可以通过更改
  373.     //在主要配置中的`iris＃WithPostMaxMemory`配置器传递给`app.Run`的第二个参数。
  375.     PostValues(name string) []string
  377.     // FormFile返回从客户端收到的第一个上传文件。
  378.     //默认表单的内存最大大小为32MB，可以通过更改
  379.     //在主要配置中的`iris＃WithPostMaxMemory`配置器传递给`app.Run`的第二个参数。
  380.     //示例：https：//github.com/kataras/iris/tree/master/_examples/http_request/upload-file
  382.     FormFile(key string) (multipart.File, *multipart.FileHeader, error)
  383.     // UploadFormFiles从客户端上传任何收到的文件
  384.     //到系统物理位置“destDirectory”。
  386.     //第二个可选参数“before”为调用者提供了机会
  387.     //在保存到磁盘之前修改* miltipart.FileHeader，
  388.     //它可以用来根据当前请求更改文件名，
  389.     //可以更改所有FileHeader的选项。你可以忽略它
  390.     //在将文件保存到磁盘之前，您不需要使用此功能。
  391.     //请注意，它不会检查请求正文是否已流式传输。
  393.     //将复制的长度返回为int64和
  394.     //如果至少有一个新文件，则为非nil错误
  395.     //由于操作系统的权限或无法创建//
  396.     // http.ErrMissingFile如果没有收到文件。
  398.     //如果您想要接收和接受文件并手动管理它们，您可以使用`context＃FormFile`
  399.     //而是创建一个适合您需要的复制功能，下面是一般用法。
  401.     //默认表单的内存最大大小为32MB，可以通过更改
  402.     //在主要配置中的`iris＃WithPostMaxMemory`配置器传递给`app.Run`的第二个参数。
  404.     //参见`FormFile`更受控制以接收文件。
  405.     //示例：https：//github.com/kataras/iris/tree/master/_examples/http_request/upload-files
  406.     UploadFormFiles(destDirectory string, before ...func(Context, *multipart.FileHeader)) (n int64, err error)
  407.     //  +------------------------------------------------------------+
  408.     //  | 自定义HTTP错误                                               |
  409.     //  +------------------------------------------------------------+
  410.     // NotFound使用特定的自定义错误错误处理程序向客户端发出错误404。
  411.     //请注意，如果您不想使用下一个处理程序，则可能需要调用ctx.StopExecution（）
  412.     //被执行下一个处理程序正在iris上执行，因为你可以使用它
  413.     //错误代码并将其更改为更具体的错误代码，即
  414.     // users：= app.Party（“/ users”）
  415.     // users.Done（func（ctx context.Context）{if ctx.StatusCode（）== 400 {/ * / users * /}的自定义错误代码}）
  416.     NotFound()
  417.     //  +------------------------------------------------------------+
  418.     //  | Body Readers                                               |
  419.     //  +------------------------------------------------------------+
  420.     // SetMaxRequestBodySize设置请求主体大小的限制
  421.     //应该在从客户端读取请求主体之前调用。
  422.     SetMaxRequestBodySize(limitOverBytes int64)
  424.     // UnmarshalBody读取请求的正文并将其绑定到任何类型的值或指针。
  425.     //用法示例：context.ReadJSON，context.ReadXML。
  427.     //例如: https://github.com/kataras/iris/blob/master/_examples/http_request/read-custom-via-unmarshaler/main.go
  428.     UnmarshalBody(outPtr interface{}, unmarshaler Unmarshaler) error
  429.     // ReadJSON从请求的主体读取JSON，并将其绑定到任何json-valid类型的值的指针。
  431.     // 例如: https://github.com/kataras/iris/blob/master/_examples/http_request/read-json/main.go
  432.     ReadJSON(jsonObjectPtr interface{}) error
  433.     // ReadXML从请求的正文中读取XML，并将其绑定到任何xml-valid类型值的指针。
  435.     // 例如: https://github.com/kataras/iris/blob/master/_examples/http_request/read-xml/main.go
  436.     ReadXML(xmlObjectPtr interface{}) error
  438.     // ReadForm将formObject与表单数据绑定在一起
  439.     //它支持任何类型的结构。
  440.     // Example: https://github.com/kataras/iris/blob/master/_examples/http_request/read-form/main.go
  441.     ReadForm(formObjectPtr interface{}) error
  442.     //  +------------------------------------------------------------+
  443.     //  | Body (raw) Writers                                         |
  444.     //  +------------------------------------------------------------+
  445.     // Write将数据作为HTTP回复的一部分写入连接。
  446.     //如果尚未调用WriteHeader，则写入调用
  447.     //在写入数据之前写入WriteHeader（http.StatusOK）。如果是标题
  448.     //不包含Content-Type行，Write添加Content-Type集
  449.     //将最初的512字节写入数据传递给的结果
  450.     // DetectContentType。
  452.     //根据HTTP协议版本和客户端，调用
  453.     // Write或WriteHeader可能会阻止将来读取
  454.     // Request.Body。对于HTTP / 1.x请求，处理程序应该读取任何内容
  455.     //在编写响应之前需要请求正文数据。一旦
  456.     //标头已被刷新（由于显式的Flusher.Flush
  457.     //调用或写入足够的数据来触发刷新），即请求体
  458.     //可能无法使用对于HTTP / 2请求，Go HTTP服务器允许
  459.     //处理程序在同时继续读取请求体
  460.     //写回复但是，可能不支持此类行为
  461.     //由所有HTTP / 2客户端。处理者应在写作前阅读
  462.     //可以最大化兼容性。
  463.     Write(body []byte) (int, error)
  465.     // Writef根据格式说明符格式化并写入响应。
  467.     //返回写入的字节数和遇到的任何写入错误。
  468.     Writef(format string, args ...interface{}) (int, error)
  470.     // WriteString将一个简单的字符串写入响应。
  472.     //返回写入的字节数和遇到的任何写入错误。
  473.     WriteString(body string) (int, error)
  475.     // SetLastModified根据“modtime”输入设置“Last-Modified”。
  476.     //如果“modtime”为零，那么它什么都不做。
  478.     //它主要内部在核心/路由器和上下文包上。
  479.     //注意正在使用modtime.UTC（）而不仅仅是modtime，所以
  480.     //你不必知道内部结构才能使其有效。
  481.     SetLastModified(modtime time.Time)
  482.     // CheckIfModifiedSince检查自“modtime”以来是否修改了响应。
  483.     //请注意，它与服务器端缓存无关。
  484.     //它通过检查“If-Modified-Since”请求标头来执行这些检查
  485.     //由客户端或以前的服务器响应头发送
  486.     //（例如WriteWithExpiration或StaticEmbedded或Favicon等）
  487.     //是有效的，它在“modtime”之前。
  489.     //检查！modtime && err == nil是必要的，以确保
  490.     //它没有被修改，因为它可能会返回false而不是偶数
  491.     //由于某些错误，有机会检查客户端（请求）标头，
  492.     //喜欢HTTP方法不是“GET”或“HEAD”或者“modtime”是零
  493.     //或者从头部解析时间失败。
  495.     //它主要用于内部，例如`环境＃WriteWithExpiration`。
  496.     //注意正在使用modtime.UTC（）而不仅仅是modtime，所以
  497.     //你不必知道内部结构才能使其有效。
  498.     CheckIfModifiedSince(modtime time.Time) (bool, error)
  500.     // WriteNotModified向客户端发送304“未修改”状态代码，
  501.     //它确保内容类型，内容长度标题
  502.     //在发送响应之前删除任何“ETag”。
  504.     //它主要在core / router / fs.go和context方法的内部使用。
  505.     WriteNotModified()
  507.     // WriteWithExpiration类似于Write但它发送的是到期日期时间
  508.     //刷新每个包级别的“StaticCacheDuration”字段。
  509.     WriteWithExpiration(body []byte, modtime time.Time) (int, error)
  511.     // StreamWriter注册给定的流编写器以进行填充
  512.     //回复正文
  514.     //禁止从作者访问上下文和/或其成员。
  515.     //此功能可用于以下情况：
  517.     // *如果响应主体太大（超过iris.LimitRequestBodySize（如果已设置））。
  518.     // *如果响应正文从缓慢的外部源流式传输。
  519.     // *如果必须以块的形式将响应主体流式传输到客户端。
  520.     //（又名`http server push`）。
  522.     //接收一个接收响应编写器的函数
  523.     //并在它应该停止写入时返回false，否则为true以便继续
  524.     StreamWriter(writer func(w io.Writer) bool)
  525.     //  +------------------------------------------------------------+
  526.     //  | Body Writers with compression                              |
  527.     //  +------------------------------------------------------------+
  528.     //如果客户端支持gzip压缩，则ClientSupportsGzip重新为true。
  529.     ClientSupportsGzip() bool
  531.     // WriteGzip接受字节，压缩为gzip格式并发送到客户端。
  532.     //返回写入的字节数和错误（如果客户端不支持gzip压缩）
  533.     //您可以在同一个处理程序中重用此函数
  534.     //多次写入更多数据，没有任何麻烦
  535.     WriteGzip(b []byte) (int, error)
  536.     // TryWriteGzip接受字节，压缩为gzip格式并发送到客户端。
  537.     //如果客户端不支持gzip，则内容按原样写入，未压缩。
  538.     TryWriteGzip(b []byte) (int, error)
  540.     // GzipResponseWriter将当前响应编写器转换为响应编写器
  541.     //当它的.Write调用它时，将数据压缩为gzip并将它们写入客户端。
  542.     //
  543.     //也可以使用.Disable和.ResetBody来禁用它以回滚到通常的响应编写器。
  544.     GzipResponseWriter() *GzipResponseWriter
  546.     //如果客户端，Gzip启用或禁用（如果在之前启用）gzip响应编写器
  547.     //支持gzip压缩，因此以下响应数据将会
  548.     //作为压缩的gzip数据发送到客户端。
  549.     Gzip(enable bool)
  550.     //  +------------------------------------------------------------+
  551.     //  | Rich Body Content Writers/Renderers                        |
  552.     //  +------------------------------------------------------------+
  553.     // ViewLayout在.View时设置“layout”选项
  554.     //后来在同一个请求中被调用。
  555.     //当需要根据链中的先前处理程序设置或/和更改布局时很有用。
  556.     //
  557.     //注意'layoutTmplFile'参数可以设置为iris.NoLayout || view.NoLayout
  558.     //禁用特定视图渲染操作的布局，
  559.     //它会禁用引擎配置的布局属性。
  561.     // Look .ViewData and .View too.
  563.     // Example: https://github.com/kataras/iris/tree/master/_examples/view/context-view-data/
  564.     ViewLayout(layoutTmplFile string)
  566.     // ViewData保存一个或多个键值对，以便在.View时传递
  567.     //后来在同一个请求中被调用。
  568.     //当需要设置或/和更改链中先前hanadler的模板数据时很有用。
  570.     //如果.View的“绑定”参数不是nil而且它不是一种地图
  571.     //然后忽略这些数据，绑定具有优先级，因此主路径的处理程序仍然可以决定。
  572.     //如果绑定是map或context.Map，那么这些数据将被添加到视图数据中
  573.     //并传递给模板。
  575.     //在.View之后，数据不会被销毁，以便在需要时重新使用（同样，在与其他所有相同的请求中），
  576.     //清除视图数据，开发人员可以调用：
  577.     // ctx.Set（ctx.Application（）。ConfigurationReadOnly（）。GetViewDataContextKey（），nil）
  579.     //如果'key'为空，则将值添加为（struct或map），并且开发人员无法添加其他值。
  581.     // Look .ViewLayout and .View too.
  582.     // Example: https://github.com/kataras/iris/tree/master/_examples/view/context-view-data/
  583.     ViewData(key string, value interface{})
  585.     // GetViewData返回`context #ViewData`注册的值。
  586.     //返回值是`map [string] interface {}`，这意味着
  587.     //如果一个自定义结构注册到ViewData那么这个函数
  588.     //将尝试解析它以进行映射，如果失败则返回值为nil
  589.     //如果不同，检查零是一个很好的做法
  590.     //通过`ViewData`注册了一些值或没有数据。
  591.     //类似于这样 `viewData := ctx.Values().Get("iris.viewData")` 或者
  592.     //`viewData := ctx.Values().Get(ctx.Application().ConfigurationReadOnly().GetViewDataContextKey())`.
  593.     GetViewData() map[string]interface{}
  594.     // View根据注册的视图引擎呈现模板。
  595.     //第一个参数接受相对于视图引擎的目录和扩展名的文件名，
  596.     //即：如果目录是“./templates”并想要呈现“./templates/users/index.html”
  597.     //然后你传递“users / index.html”作为文件名参数。
  599.     //第二个可选参数可以接收单个“视图模型”
  600.     //如果它不是nil，它将绑定到视图模板，
  601.     //否则会检查`ViewData`存储的先前视图数据
  602.     //即使存储在任何先前的handlerv（中间件）中，也存在相同的请求。
  604.     //也看.ViewData`和.ViewLayout。
  606.     //示例：https://github.com/kataras/iris/tree/master/_examples/view
  607.     View(filename string, optionalViewModel ...interface{}) error
  609.     // 二进制将原始字节写为二进制数据。
  610.     Binary(data []byte) (int, error)
  611.     // Text将字符串写为纯文本。
  612.     Text(text string) (int, error)
  613.     // HTML将字符串写为 text/html。
  614.     HTML(htmlContents string) (int, error)
  615.     // JSON 整理给定的接口对象并写入JSON响应。
  616.     JSON(v interface{}, options ...JSON) (int, error)
  617.     // JSONP  整理给定的接口对象并写入JSON响应
  618.     JSONP(v interface{}, options ...JSONP) (int, error)
  619.     // XML  整理给定的接口对象并写入xml响应.
  620.     XML(v interface{}, options ...XML) (int, error)
  621.     //Markdown 将markdown解析为html并将其结果呈现给客户端。
  622.     Markdown(markdownB []byte, options ...Markdown) (int, error)
  623.     // 用yaml解析器解析“v”并将其结果呈现给客户端。
  624.     YAML(v interface{}) (int, error)
  625.     //  +------------------------------------------------------------+
  626.     //  | Serve files                                                |
  627.     //  +------------------------------------------------------------+
  628.     // ServeContent提供内容，标题是自动设置的
  629.     //接收三个参数，它是低级函数，而不是你可以使用.ServeFile（string，bool）/ SendFile（string，string）
  631.     //在此函数调用之前，您可以使用`context＃ContentType`定义自己的“Content-Type”。
  633.     //此函数不支持恢复（按范围），
  634.     //使用ctx.SendFile或路由器的`StaticWeb`代替。
  635.     ServeContent(content io.ReadSeeker, filename string, modtime time.Time, gzipCompression bool) error
  637.     // ServeFile提供一个文件（例如发送一个文件，一个zip到客户端你应该使用`SendFile`）
  638.     //接收两个参数
  639.     //文件名/路径（字符串）
  640.     // gzipCompression（bool）
  642.     //在此函数调用之前，您可以使用`context＃ContentType`定义自己的“Content-Type”。
  643.     //
  644.     //此函数不支持恢复（按范围），
  645.     //使用ctx.SendFile或路由器的`StaticWeb`代替。
  647.     //当您想要向客户端提供动态文件时使用它。
  648.     ServeFile(filename string, gzipCompression bool) error
  650.     // SendFile将文件强制下载发送到客户端
  651.     //使用此代替ServeFile来“强制下载”更大的文件到客户端。
  652.     SendFile(filename string, destinationName string) error
  653.     //  +------------------------------------------------------------+
  654.     //  | Cookies                                                    |
  655.     //  +------------------------------------------------------------+
  656.     // SetCookie添加了一个cookie
  657.     SetCookie(cookie *http.Cookie)
  659.     // SetCookieKV添加一个cookie，只接收一个名字（字符串）和一个值（字符串）
  661.     //如果您使用此方法，它将在2小时后到期
  662.     //如果要更改更多字段，请使用ctx.SetCookie或http.SetCookie。
  663.     SetCookieKV(name, value string)
  665.     // GetCookie按名称返回cookie的值
  666.     //如果没有找到，则返回空字符串。
  667.     GetCookie(name string) string
  668.     // RemoveCookie按名称删除cookie。
  669.     RemoveCookie(name string)
  671.     // VisitAllCookies接受一个循环的访问者
  672.     //在每个（请求的）cookie的名称和值上。
  673.     VisitAllCookies(visitor func(name string, value string))
  675.     // MaxAge返回“缓存控制”请求标头的值
  676.     //秒为int64
  677.     //如果未找到标头或解析失败，则返回-1。
  678.     MaxAge() int64
  679.     //  +------------------------------------------------------------+
  680.     //  | Advanced: Response Recorder and Transactions               |
  681.     //  +------------------------------------------------------------+
  682.     // Record将上下文的基本和直接responseWriter转换为ResponseRecorder
  683.     //可用于重置body，重置标头，获取body，
  684.     //随时随地获取和设置状态代码。
  685.     Record()
  687.     // Recorder返回上下文的ResponseRecorder
  688.     //如果没有录制，则开始录制并返回新上下文的ResponseRecorder
  689.     Recorder() *ResponseRecorder
  691.     // IsRecording返回响应记录器和真值
  692.     //当响应作者正在记录状态代码，正文，标题等时，
  693.     // else返回nil和false。
  694.     IsRecording() (*ResponseRecorder, bool)
  696.     / BeginTransaction启动范围内的事务。
  697.     //您可以搜索有关业务交易如何运作的第三方文章或书籍（这很简单，尤其是在这里）。
  698.     //请注意，这是独一无二的
  699.     //（=我在Golang上从未见过关于此主题的任何其他示例或代码，到目前为止，与大多数虹膜功能一样......）
  700.     //它不包括所有路径
  701.     //例如数据库，这应该由用于建立数据库连接的库来管理，
  702.     //此事务范围仅用于上下文的响应。
  703.     //交易也有自己的中间件生态系统，看看iris.go：UseTransaction。
  705.     // 参考 https://github.com/kataras/iris/tree/master/_examples/ for more
  706.     BeginTransaction(pipe func(t *Transaction))
  708.     //如果调用SkipTransactions，则跳过其余的事务
  709.     //如果在第一次交易之前调用，则为全部
  710.     SkipTransactions()
  711.     //如果事务被跳过或取消，则TransactionsSkipped返回true。
  712.     TransactionsSkipped() bool
  714.     // Exec调用`context / Application #ServeCtx`
  715.     //基于此上下文但具有更改的方法和路径
  716.     //喜欢它是用户请求的，但事实并非如此。
  717.     //
  718.     //离线表示路由已注册到虹膜，并具有正常路由所具有的所有功能
  719.     //但它不能通过浏览获得，它的处理程序仅在其他处理程序的上下文调用它们时执行
  720.     //它可以验证路径，有会话，路径参数等等。
  722.     //你可以通过app.GetRoute找到路线（“theRouteName”）
  723.     //您可以将路径名称设置为：myRoute：= app.Get（“/ mypath”，handler）（“theRouteName”）
  724.     //将为路由设置名称并返回其RouteInfo实例以供进一步使用。
  726.     //它不会更改全局状态，如果路由处于“离线状态”，它将保持脱机状态。
  727.     // app.None（...）和app.GetRoutes（）。离线（路线）/。在线（路线，方法）
  728.     //示例：https：//github.com/kataras/iris/tree/master/_examples/routing/route-state
  730.     //用户可以通过简单的使用rec：= ctx.Recorder（）获得响应; rec.Body（）/ rec.StatusCode（）/ rec.Header（）。
  731.     //保留Context的值和Session，以便能够通过结果路由进行通信。
  733.     //这是针对极端用例的，99％的情况永远不会对你有用。
  734.     Exec(method, path string)
  736.     // RouteExists报告特定路由是否存在
  737.     //如果不在根域内 ，它将从上下文主机的当前子域搜索。
  738.     RouteExists(method, path string) bool
  740.     // Application返回属于此上下文的iris app实例。
  741.     //值得注意的是这个函数返回一个接口
  742.     //应用程序，包含安全的方法
  743.     //在服务时间执行。完整的应用程序的字段
  744.     //这里没有方法可供开发人员使用。
  745.     Application() Application
  747.     // String返回此请求的字符串表示形式。
  748.     //每个上下文都有一个唯一的字符串表示
  749.     //它可以用于简单的调试场景，即打印上下文为字符串。
  750.     //它返回什么？一个声明长度的数字
  751.     //跟随每个可执行应用程序的总`String`调用
  752.     //通过远程IP（客户端），最后是方法：url。
  753.     String() string
  754. }