欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

springboot RESTful以及参数注解的使用方式

程序员文章站 2022-06-21 23:54:37
目录springboot restful及参数注解使用restful1、@getmapping2、@postmapping3、@putmapping4、@deletemapping5、@patchma...

springboot restful及参数注解使用

restful

spring的复杂性不是来自于它处理的对象,而是来自于自身,不断演进发展的spring会带来时间维度上复杂性,比如springmvc以前版本的@requestmapping,到了新版本被下面新注释替代,相当于增加的选项:

@getmapping
@postmapping
@putmapping
@deletemapping
@patchmapping

说明

1、@getmapping

@requestmapping(method = requestmethod.get)的简写

作用:对应查询,表明是一个查询url映射

2、@postmapping

@requestmapping(method = requestmethod.post)的简写

作用:对应增加,表明是一个增加url映射

3、@putmapping

@requestmapping(method = requestmethod.put)的简写

作用:对应更新,表明是一个更新url映射

4、@deletemapping

@requestmapping(method = requestmethod.delete)的简写

作用:对应删除,表明是一个删除url映射

5、@patchmapping

patch方式是对put方式的一种补充;

put方式是可以更新.但是更新的是整体.patch是对局部更新;

参数注解的使用

@pathvariable
@requestparam
@requestbody
@modelattribute

说明

1. @pathvariable

获取路径参数。即url/{id}这种形式

@pathvariable绑定uri模板变量值

@pathvariable是用来获得请求url中的动态参数的

@pathvariable用于将请求url中的模板变量映射到功能处理方法的参数上。//配置url和方法的一个关系@requestmapping(“item/{itemid}”)

2.@requestparam

获取查询参数。即url?name=这种形式

@requestparam注解主要有哪些参数:

  • value:参数名字,即入参的请求参数名字,如username表示请求的参数区中的名字为username的参数的值将传入;
  • required:是否必须,默认是true,表示请求中一定要有相应的参数,否则将报404错误码;
  • defaultvalue:默认值,表示如果请求中没有同名参数时的默认值,例如:
public list getitemtreenode(@requestparam(value=“id”,defaultvalue=“0”)long parentid)

3.@requestbody

@requestbody注解常用来处理content-type不是默认的application/x-www-form-urlcoded编码的内容,比如说:application/json或者是application/xml等。一般情况下来说常用其来处理application/json类型。

通过@requestbody可以将请求体中的json字符串绑定到相应的bean上,当然,也可以将其分别绑定到对应的字符串上。

4.@modelattribute

在使用restful风格时,使用get请求,又想使用对象接收参数,就可以使用这个注解

不光适用于get请求,同样也适用于put和delete请求

springboot restful使用记录

创建项目

通过spring官网创建项目

springboot RESTful以及参数注解的使用方式

  • 项目名称取为studyrest
  • 项目依赖web

rest组件使用

使用@restcontroller标记类为提供restful服务的contoller

@getmapping为资源定位一部分,也就是url,对应http://localhost:8080/test

@restcontroller
public class myrestcontoller1 {
	@getmapping("/test")
	public map<string, string> getdata() {
		map<string, string> data = new hashmap<string, string>();
		data.put("id", "111");
		data.put("name", "zhangsan");
		return data;
	}
}

测试(这里使用浏览器测试,后续使用postman工具)

springboot RESTful以及参数注解的使用方式

@getmapping关键字对应get请求,也就是查询,请求还可以有参数,对应@pathvariable与@requestparam注解

	@getmapping("/test/{id}")
	public map<string, string> getdata2(@pathvariable string id, @requestparam(required = false) string name) {
		map<string, string> data = new hashmap<string, string>();
		data.put("id", id);
		data.put("name", name);
		return data;
	}

测试,返回值为入参传入参数

springboot RESTful以及参数注解的使用方式

post类型,新增操作

新增使用@postmapping描述url

新增一般都会带有大量数据,一般都是使用@requestbody注解封装参数

	@postmapping("/test2/add")
	public map<string, string> adddata(@requestbody map<string, string> data) {
		return data;
	}

测试

springboot RESTful以及参数注解的使用方式

注意两点,不正确都会报错

  • 请求类型必须是post
  • content-type必须要设置为application/json,因为入参形式为json格式

springboot RESTful以及参数注解的使用方式

更新与删除操作

使用上与post一致,只是不同类型需要使用对应的主机

  • put:@putmapping
  • delete:@deletemapping
	@putmapping("/test2/update")
	public map<string, string> updatedata(@requestbody map<string, string> data) {
		return data;
	}
	
	@deletemapping("/test2/delete")
	public map<string, string> deletedata(@requestbody map<string, string> data) {
		return data;
	}

requestmapping使用

requestmapping是一个通用注解,包含上述所有操作

@restcontroller
@requestmapping(value = "/parent")
public class requestrestcontoller {
	@requestmapping(value = "/get", method = requestmethod.get)
	public map<string, string> get() {
		map<string, string> data = new hashmap<string, string>();
		data.put("id", "111");
		data.put("name", "zhangsan");
		return data;
	}
	
	@requestmapping(value = "/add", method = requestmethod.post)
	public map<string, string> add() {
		map<string, string> data = new hashmap<string, string>();
		data.put("id", "111");
		data.put("name", "zhangsan");
		return data;
	}
	
	@requestmapping(value = "/update", method = requestmethod.put)
	public map<string, string> update() {
		map<string, string> data = new hashmap<string, string>();
		data.put("id", "111");
		data.put("name", "zhangsan");
		return data;
	}
	
	@requestmapping(value = "/delete", method = requestmethod.delete)
	public map<string, string> delete() {
		map<string, string> data = new hashmap<string, string>();
		data.put("id", "111");
		data.put("name", "zhangsan");
		return data;
	}
}

上述还有贴在class上面的注解:@requestmapping(value = "/parent"),如果是class上面的注解,那么方法上面的url需要加上class上面的注解

如:http://localhost:8080/parent/get或http://localhost:8080/parent/add

其中可以属于请求参数和响应数据类型

@requestmapping(value = "/parent", consumes = mediatype.application_json_value, produces = mediatype.application_json_value)

其中consumes 约束入参类型,produces 约束响应数据类型

测试content-type:text/plain报错,由于设置了json格式

springboot RESTful以及参数注解的使用方式

支持哪些格式参考media定义

org.springframework.http.mediatype

xml格式数据支持

这里扩展一下,返回xml格式数据

引入xml依赖包

	<dependency>
		<groupid>com.fasterxml.jackson.dataformat</groupid>
		<artifactid>jackson-dataformat-xml</artifactid>
	</dependency>

测试类

@restcontroller
public class datarestcontoller {
	@requestmapping(value = "/addjsonresponsexml", consumes = mediatype.application_json_value, produces = mediatype.application_xml_value)
	public map<string, string> add(@requestbody map<string, string> data) {
		return data;
	}
}

测试

springboot RESTful以及参数注解的使用方式

以上为个人经验,希望能给大家一个参考,也希望大家多多支持。