示例注解,场景为用户的获取
@Path
拼接url 。例如 http://localhost:8080/User/Info/小明
其中User 是后端Controller 。Info是方法。小明是请求参数
-
客户端:
@GET("Info/{name}")
Call<User> userInfo(@Path("name") String name);
-
后端
@GetMapping("/Info/{name}")
public User getUserInfo(@PathVariable("name") String name) {
return userDao.findUserByName(name);
}
@Body.
放入Body中以JSON字符串给到后端,所以后端如果加了@RequestBody,使用@Body进行传递
- 客户端
@POST("Save")
Call<User> save(@Body User user);
- 后端
@PostMapping("/Save")
public User save(@RequestBody User user){
Date date=new Date();
user.setCode(date.getTime()+user.getName());
userDao.save(user);
return user;
}
@Query
拼接url,以http://localhost:8080/User/getQuery?name="小U"
- 客户端:
@GET("getQuery")
Observable<User> getUserInfoByRxjava(@Query("name") String name);
- 后端
@GetMapping("/getQuery")
public User getQueryInfoByRxJava(String name){
return userDao.findUserByName(name);
}
@QueryMap
拼接url,和@Query一样,不过变成了多个key value拼接
- 客户端
@POST("getQueryMap")
Observable<List<User>> getUserInfoByRxJavaQueryMap(@QueryMap Map<String,String> map);
- 后端接收一个实体或者vo类:
@PostMapping("/getQueryMap")
public List<User> getQueryMap(User user){
String name = user.getName();
String address = user.getAddress();
String sex = user.getSex();
StringBuffer sb=new StringBuffer();
sb.append("select * from sys_user u");
sb.append(" where u.name like'%"+name);
sb.append("%' and u.address like'%"+address);
sb.append("%' and u.sex='"+sex+"'");
Query nativeQuery =
entityManager.createNativeQuery(sb.toString(),User.class);
List<User> resultList = nativeQuery.getResultList();
return resultList;
}
@Filed
和@Query类似。不过一个是放到url拼接,而Filed是表单的形式提交,另外需要注意的是,无论使用get还是post方式 都需要和@FormUrlEncode配合使用,否则会报错
java.lang.IllegalArgumentException: @Field parameters can only be used with form encoding. (parameter #1)
- 客户端
@FormUrlEncoded
@POST("getFiled")
Observable<User> getFiled(@Field("name") String name);
- 后端 这里可以看到和@Query方式后端获取数据的方法是一样的,所以说@Query和@Filed差别只是参数传递的方式不一样
@PostMapping("getFiled")
public User getFiled(String name){
return userDao.findUserByName(name);
}
@FiledMap
略参考QueryMap和Query之间。FiledMap和Filed就是一个参数,一个是多参数。
@Part
一般多用于上传,通常和PartMap配合
@PartMap
与 Part配合,一般多用于上传
@Url
下面两种都是添加请求头
@Header
@Headers
欢迎指正~