Beego中Ctx.Input.GetData方法功能及传值方式咨询

Hey there! Let's break down this Beego code step by step so you can wrap your head around what's going on, especially since you're new to Beego and Go.

First: What's the Prepare() method? #

You're spot-on to think of it like a filter! In Beego, Prepare() is a pre-request hook that automatically runs before any of your controller's action methods (like GetOne in your code). It’s designed for common setup or validation tasks that need to happen before handling the actual request—think session checks, permission validation, or shared data initialization.

What do c.Ctx.Input.GetData("customerid") and c.Ctx.Input.GetData("customergroupid") do? #

These methods fetch custom data stored in the request context (the Ctx object). Unlike query parameters, form data, or request headers, this data isn’t sent directly by the client. Instead, it’s data that was added earlier in the request lifecycle (by a filter, parent controller, or middleware) to share between different parts of your application.

Think of the request context as a temporary storage box for the duration of a single request—you can put things in it early on, then pull them out later when you need them.

Let's walk through your code flow #

1. URLMapping: The URLMapping() method tells Beego that the GetOne action should handle requests to this controller's route. When a GET request comes in, Beego triggers this mapping first.
2. Prepare() runs automatically: Before GetOne executes, Beego calls Prepare():
   • First check: If customerid is an empty string, it returns a 403 "Invalid Session" JSON response and calls StopRun()—this halts all further processing, so GetOne never runs.
   • Second check: If customergroupid is empty or nil, it returns a 404 "User not a campus manager" JSON response and stops execution.
   • If both checks pass, Beego proceeds to run the GetOne method to handle the request.

How to pass values to these GetData() calls? #

To make GetData() return valid values, you need to store them in the context first using c.Ctx.Input.SetData(key, value). Here are the most common ways to do this:

1. Use a Beego Filter #

Filters are global or route-specific hooks that run before your controller's Prepare() method. You can use them to parse session data, validate tokens, and store user info in the context.

Example of a global filter:

import "github.com/astaxie/beego/context"

func init() {
    // This filter runs for all routes before the controller's Prepare()
    beego.InsertFilter("/*", beego.BeforeRouter, func(ctx *context.Context) {
        // Example: Parse a JWT token from the request header
        token := ctx.Input.Header("Authorization")
        // Assume parseToken is your custom function to extract user data from the token
        customerID, customerGroupID := parseToken(token)
        
        // Store the values in the context
        ctx.Input.SetData("customerid", customerID)
        ctx.Input.SetData("customergroupid", customerGroupID)
    })
}

2. Use a Base Controller #

If multiple controllers need this session/permission check, create a base controller with its own Prepare() that stores the data, then have your CampusHomeController inherit from it.

Example:

type BaseController struct {
    beego.Controller
}

func (c *BaseController) Prepare() {
    // Get user data from Beego's built-in session (if you're using sessions)
    customerID := c.GetSession("customerid")
    if customerID != nil {
        c.Ctx.Input.SetData("customerid", customerID.(string))
    }
    
    // Fetch and store customergroupid similarly
    groupID := c.GetSession("customergroupid")
    if groupID != nil {
        c.Ctx.Input.SetData("customergroupid", groupID.(string))
    }
}

// Have your controller inherit from BaseController
type CampusHomeController struct {
    BaseController
}

A quick note about type safety #

Your current code compares GetData() results directly to strings, but GetData() returns an interface{}. If you store a non-string value (like an int), this comparison will fail silently. To avoid this, you should type-assert the value first, like:

customerID, ok := c.Ctx.Input.GetData("customerid").(string)
if !ok || customerID == "" {
    // Handle invalid or missing customerid
}

内容的提问来源于stack exchange，提问作者Karthik