下面是SpringMVC Restful api接口实现的代码攻略:
准备工作
在使用SpringMVC实现Restful API之前,必须先进行以下几个准备工作:
- 在Maven中添加SpringMVC依赖。
- 配置web.xml文件。
- 配置SpringMVC配置文件。
配置web.xml文件
首先,在web.xml中添加DispatcherServlet的配置:
<servlet>
<servlet-name>dispatcherServlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring-servlet.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcherServlet</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
其中,servlet-name可以自己定义,servlet-class为DispatcherServlet的全限定名,contextConfigLocation指定了DispatcherServlet的配置文件路径(即SpringMVC配置文件)。
配置SpringMVC配置文件
在SpringMVC配置文件中,需要进行以下几个配置:
- 开启注解扫描。
- 配置视图解析器。
- 配置静态资源映射。
- 配置Restful API。
其中,第4个配置项是本篇攻略的重点。以下是其配置方式:
<!-- 开启默认的注解支持 -->
<mvc:annotation-driven />
<!-- 配置Restful API -->
<mvc:annotation-driven>
<mvc:message-converters>
<bean class="org.springframework.http.converter.StringHttpMessageConverter"/>
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"/>
</mvc:message-converters>
</mvc:annotation-driven>
<!-- 配置BaseUrl -->
<bean id="baseUrl" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="locations">
<list>
<value>classpath:config.properties</value>
</list>
</property>
</bean>
在上述代码中,使用了
编写Restful API
最后,我们需要编写Restful API的代码。以下是一个示例:
@RestController
@RequestMapping("/users")
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/")
public List<User> getAllUsers() {
return userService.getAllUsers();
}
@GetMapping("/{id}")
public User getUserById(@PathVariable Long id) {
return userService.getUserById(id);
}
@PostMapping("/")
public User addUser(@RequestBody User user) {
return userService.addUser(user);
}
@PutMapping("/")
public User updateUser(@RequestBody User user) {
return userService.updateUser(user);
}
@DeleteMapping("/{id}")
public void deleteUser(@PathVariable Long id) {
userService.deleteUser(id);
}
}
在上述代码中,首先使用@RestController注解来标识这是一个RESTful API组件,使用@RequestMapping注解来映射这个组件到/users这个URI。
接下来,我们使用GetMapping、PostMapping、PutMapping、DeleteMapping注解来标识对应的HTTP请求方法(GET、POST、PUT、DELETE),并且指定对应的URI。
最后,我们通过调用UserService的各种方法来实现对用户的CRUD操作。
以上就是SpringMVC Restful api接口实现的代码攻略。
本站文章如无特殊说明,均为本站原创,如若转载,请注明出处:SpringMVC Restful api接口实现的代码 - Python技术站