SpringBoot接口获取参数的常用注解详解

// 获取单个参数
@getmapping("/user/{id}")
public user getuserbyid(@pathvariable long id) {
    return userservice.findbyid(id);
}

// 获取多个参数
@getmapping("/user/{id}/post/{postid}")
public string getinfo(
    @pathvariable long id,
    @pathvariable long postid
) {
    // ...
}

// 参数名不一致时指定
@getmapping("/user/{userid}")
public user getuser(@pathvariable("userid") long id) {
    return userservice.findbyid(id);
}

// 获取所有路径变量（map形式）
@getmapping("/user/{id}/post/{postid}")
public string getinfo(@pathvariable map<string, string> pathvariables) {
    return pathvariables.get("id");
}

// url路径中的时间参数
@getmapping("/events/date/{date}")
public list<event> geteventsbypathdate(
    @pathvariable @datetimeformat(pattern = "yyyy-mm-dd") date date) {
    return eventservice.findbydate(date);
}

@getmapping("/events/datetime/{datetime}")
public string getbydatetime(
    @pathvariable @datetimeformat(pattern = "yyyy-mm-dd hh:mm:ss") localdatetime datetime) {
    return "时间: " + datetime;
}

// 必填参数
@getmapping("/users")
public list<user> getusers(@requestparam string name) {
    return userservice.findbyname(name);
}

// 可选参数
@getmapping("/users")
public list<user> getusers(
    @requestparam(required = false) string name,
    @requestparam(defaultvalue = "1") int page,
    @requestparam(defaultvalue = "10") int size
) {
    return userservice.findbyname(name, page, size);
}

// 接收多个值
@getmapping("/users")
public list<user> getusers(@requestparam list<long> ids) {
    return userservice.findbyids(ids);
}

// 获取所有查询参数（map形式）
@getmapping("/search")
public string search(@requestparam map<string, string> params) {
    return params.get("keyword");
}

// 查询参数中的时间
@getmapping("/events")
public list<event> geteventsbydate(
    @requestparam @datetimeformat(pattern = "yyyy-mm-dd") date date) {
    return eventservice.findbydate(date);
}

// 多个时间参数
@getmapping("/events/range")
public list<event> geteventsbyrange(
    @requestparam @datetimeformat(pattern = "yyyy-mm-dd") date startdate,
    @requestparam @datetimeformat(iso = datetimeformat.iso.date_time) localdatetime endtime) {
    return eventservice.findbydaterange(startdate, endtime);
}

@postmapping("/user")
public user createuser(@requestbody user user) {
    return userservice.save(user);
}

// 接收 map 类型的请求体
@postmapping("/data")
public string processdata(@requestbody map<string, object> data) {
    return data.tostring();
}

// 使用 dto 接收参数
@postmapping("/register")
public responseentity<?> register(@requestbody registerdto registerdto) {
    // 处理注册逻辑
    return responseentity.ok("注册成功");
}

// 绑定到对象
@postmapping("/user")
public string createuser(@modelattribute user user) {
    userservice.save(user);
    return "success";
}

// 绑定到 map
@postmapping("/user")
public string createuser(@modelattribute map<string, object> model) {
    return model.get("name").tostring();
}

@getmapping("/info")
public string getinfo(
    @requestheader("user-agent") string useragent,
    @requestheader(value = "authorization", required = false) string auth,
    @requestheader map<string, string> headers
) {
    return "user-agent: " + useragent;
}

@getmapping("/profile")
public string getprofile(@cookievalue("sessionid") string sessionid) {
    return "session id: " + sessionid;
}

// 可选参数
@getmapping("/profile")
public string getprofile(
    @cookievalue(value = "sessionid", defaultvalue = "default") string sessionid
) {
    return "session id: " + sessionid;
}

@restcontroller
@requestmapping("/api/upload")
public class uploadcontroller {
    // 基础文件上传
    @postmapping("/single")
    public string uploadsingle(@requestpart("file") multipartfile file) {
        return "uploaded: " + file.getoriginalfilename();
    }

    // 多文件上传
    @postmapping("/multiple")
    public string uploadmultiple(@requestpart("files") multipartfile[] files) {
        return "uploaded " + files.length + " files";
    }

    // 文件 + json对象
    @postmapping(value = "/upload", consumes = mediatype.multipart_form_data_value)
    public string uploaddata(@requestpart("file") multipartfile file, 
                             @requestpart("metadata") mymetadata metadata) {
        // metadata 是自定义的 json 对象
        return "uploaded file with metadata";
    }
    
    // 文件 + 表单字段
    @postmapping(value = "/upload-with-data", consumes = mediatype.multipart_form_data_value)
    public responseentity<?> uploadwithdata(
                                            @requestpart("file") multipartfile file,
                                            @requestparam("name") string name,
                                            @requestparam("description") string description) {
        // 处理文件和文本数据
        return responseentity.ok("上传成功");
    }
}

@postmapping("/upload-simple")
public string uploadsimple(@requestparam("file") multipartfile file) {
    return "文件名称: " + file.getoriginalfilename();
}

@getmapping("/dashboard")
public string dashboard(@sessionattribute("user") user user) {
    return "欢迎 " + user.getusername();
}

@getmapping("/process")
public string process(@requestattribute("processeddata") string data) {
    return "处理后的数据: " + data;
}

// url: /cars;color=red;year=2023
@getmapping("/cars")
public string getcar(@matrixvariable string color) {
    return color;
}

@getmapping("/config")
public string getconfig(@value("${app.name}") string appname) {
    return "应用名称: " + appname;
}