SpringBoot复杂参数应用详细讲解

在SpringBoot中，我们可以很方便地绑定和处理各种类型的请求参数，包括简单的字符串和数字，以及复杂的对象和集合类型。在本文中，我们将详细介绍如何处理复杂的请求参数，包括Bean对象、List和Map集合类型等。

1. Bean对象参数

对于Bean对象类型的参数，我们可以通过在控制器方法中直接声明该对象的参数来接收请求参数，SpringBoot将会自动开箱装箱，将请求参数填充到该对象的属性中。示例代码如下：

@PostMapping("/user")
public String addUser(User user) {
    // 处理添加用户的逻辑
    // ...
    return "success";
}

如果请求的参数中包含了与该Bean对象中属性名对应的参数，则SpringBoot会自动将参数值赋值给该属性。例如，如果请求的参数为：

name=Tom&age=22&sex=M

那么对应的User对象的属性值就会被自动赋值为：

User user = new User();
user.setName("Tom");
user.setAge(22);
user.setSex("M");

注意，如果请求参数中的属性名与Bean对象中的属性名不一致，可以通过给控制器方法的参数加上@RequestParam或@PathVariable注解来指定请求参数的名字。

2. List参数

对于List类型的参数，我们同样可以在控制器方法中声明该List类型的参数来接受请求参数。SpringBoot将会自动将请求参数转换为List类型，并自动添加到传入的List对象中。示例代码如下：

@PostMapping("/users")
public String addUsers(List<User> users) {
    // 处理添加用户列表的逻辑
    // ...
    return "success";
}

如果请求参数中包含多个用户的信息，可以将它们都放到一个List对象中，多个用户之间用逗号（或其他指定分隔符）分隔。例如，请求参数为：

users[0].name=Tom&users[0].age=22&users[0].sex=M&users[1].name=Lily&users[1].age=23&users[1].sex=F

那么对应的List对象中就会包含两个User对象，分别为：

List<User> users = new ArrayList<>();
User user1 = new User();
user1.setName("Tom");
user1.setAge(22);
user1.setSex("M");
users.add(user1);

User user2 = new User();
user2.setName("Lily");
user2.setAge(23);
user2.setSex("F");
users.add(user2);

同样，如果参数名不一致，可以通过@RequestParam或@PathVariable注解来指定。

3. Map参数

对于Map类型的参数，我们可以声明该Map类型的参数来接收请求参数。示例代码如下：

@PostMapping("/users/map")
public String addUsers(Map<String, User> userMap) {
    // 处理添加用户列表的逻辑
    // ...
    return "success";
}

如果请求参数中包含多个用户的信息，可以将它们都放到一个Map对象中，Map的键值对应分别为用户的标识（可以是任何类型的键）和用户信息的对象。例如，请求参数为：

users['Tom'].name=Tom&users['Tom'].age=22&users['Tom'].sex=M&users['Lily'].name=Lily&users['Lily'].age=23&users['Lily'].sex=F

那么对应的Map对象中就会包含两个User对象，键为字符串类型，分别为：

Map<String, User> userMap = new HashMap<>();
User user1 = new User();
user1.setName("Tom");
user1.setAge(22);
user1.setSex("M");
userMap.put("Tom", user1);

User user2 = new User();
user2.setName("Lily");
user2.setAge(23);
user2.setSex("F");
userMap.put("Lily", user2);

同样，如果参数名不一致，可以通过@RequestParam或@PathVariable注解来指定。

示例

示例1：处理订单项

假设我们有一个在线商城系统，需要添加订单时，需要填写订单号、订单下的多个商品信息、订单总价等信息。订单下的每个商品信息都包括商品名称、商品数量、商品单价等信息。我们可以定义以下的JavaBean来表示一个订单项的信息：

public class OrderItem {
    private String name;
    private int quantity;
    private double price;
    // getters and setters
}

定义一个JavaBean来表示订单信息：

public class Order {
    private String orderId;
    private List<OrderItem> items;
    private double totalPrice;
    // getters and setters
}

然后，在控制器中定义接口，来处理添加订单的请求：

@RestController
public class OrderController {
    @PostMapping("/order")
    public String addOrder(Order order) {
        // 处理添加订单的逻辑
        // ...
        return "success";
    }
}

当我们需要向系统添加一个包含3个商品的订单时，请求的参数应该为：

orderId=20220408001&items[0].name=iphone12&items[0].quantity=1&items[0].price=8999&items[1].name=Macbook Pro&items[1].quantity=1&items[1].price=18999&items[2].name=iPad&items[2].quantity=2&items[2].price=3999

控制器方法中收到的Order对象中应该包含3个OrderItem对象，总价为：

public String addOrder(Order order) {
    String orderId = order.getOrderId();
    double totalPrice = order.getTotalPrice();
    List<OrderItem> items = order.getItems();
    // ...
}

示例2：处理用户角色分配

假设我们有一个用户角色管理系统，需要对用户进行角色分配。定义以下的JavaBean来表示用户和角色的信息：

public class User {
    private String name;
    private int age;
    private String sex;
    private List<String> roles;
    // getters and setters
}

public class Role {
    private int id;
    private String name;
    private String description;
    // getters and setters
}

然后，在控制器中定义接口，来处理用户角色分配的请求：

@RestController
public class UserController {
    @PostMapping("/user-role")
    public String addUserRole(User user, List<Role> roles) {
        // 处理添加用户角色分配的逻辑
        // ...
        return "success";
    }
}

当我们需要为一个用户指派2个角色时，请求的参数应该为：

name=Tom&age=22&sex=M&roles[0].id=1&roles[0].name=管理员&roles[0].description=系统管理员&roles[1].id=2&roles[1].name=销售员&roles[1].description=销售人员

控制器方法中收到的User对象中应该包含用户基本信息和两个角色对象，角色对象应该被转换为List类型的参数传入。例如：

@PostMapping("/user-role")
public String addUserRole(User user, List<Role> roles) {
    String name = user.getName();
    int age = user.getAge();
    List<String> roles = user.getRoles();
    // ...
}

总结

在SpringBoot中，我们可以很方便地处理各种类型的请求参数，包括Bean对象、List和Map集合类型。我们只需要在控制器方法中声明相应类型的参数，SpringBoot会自动将请求参数装配和转换为该类型的对象。同时，我们也可以通过注解等方式来处理参数名和类型的匹配问题，实现更加灵活的参数绑定。