springboot(二)：在Web中开发应用

Spring Boot中使用Swagger2构建 RESTful API文档

              介绍RESTful API的重磅好伙伴Swagger2，它可以轻松的整合到Spring Boot中，并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量，同时说明内容又整合入实现代码中，让维护文档和修改代码整合为一体，可以让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API。

添加Swagger2依赖

在pom.xml中加入Swagger2的依赖

<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.2.2</version> </dependency>

创建Swagger2配置类

在Application.java同级创建Swagger2的配置类Swagger2。

/**
 * @Configuration注解告诉Spring加载这个类的配置。
 @EnableSwagger2
 启用Swagger2。
 apiInfo()方法添加API的基本信息.
 */

@Configuration
@EnableSwagger2
public class Swagger2Config {
   @Bean
   public Docket createRestApi() {
      return new Docket(DocumentationType.SWAGGER_2)
         .apiInfo(apiInfo())
         .select()
         .apis(RequestHandlerSelectors.basePackage("com.example.demo1.controller"))
         .paths(PathSelectors.any())
         .build();
   }

   //构建 api文档的详细信息函数
   private ApiInfo apiInfo() {
      return new ApiInfoBuilder()
         //页面标题
         .title("Spring Boot使用 Swagger2构建RESTful API")
         //创建人
         .contact("wangxianshi")
         //版本号
         .version("1.0")
         //描述
         .description("API 描述")
         .build();
   }
}

通过@Configuration注解，让Spring来加载该类配置。再通过@EnableSwagger2注解来启用Swagger2。

再通过createRestApi函数创建Docket的Bean之后，apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）。select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现，本例采用指定扫描的包路径来定义，Swagger会扫描该包下所有Controller定义的API，并产生文档内容（除了被@ApiIgnore指定的请求）。

@RestController
@RequestMapping("/user")
@Api(value="/用户信息")
public class UserController {

　　static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>());
    @ApiOperation(value="获取用户列表", notes="")
 @RequestMapping(value={""}, method=RequestMethod.GET)
 public List<User> getUserList() {
 List<User> r = new ArrayList<User>(users.values());
 return r;
 }

 @ApiOperation(value="创建用户", notes="根据User对象创建用户")
 @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
 @RequestMapping(value="", method=RequestMethod.POST)
 public String postUser(@RequestBody User user) {
 users.put(user.getId(), user);
 return "success";
 }

 @ApiOperation(value="获取用户详细信息", notes="根据url的id来获取用户详细信息")
 @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
 @RequestMapping(value="/{id}", method=RequestMethod.GET)
 public User getUser(@PathVariable Long id) {
 return users.get(id);
 }

 @ApiOperation(value="更新用户详细信息", notes="根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息")
 @ApiImplicitParams({
 @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"),
 @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
 })
 @RequestMapping(value="/{id}", method=RequestMethod.PUT)
 public String putUser(@PathVariable Long id, @RequestBody User user) {
 User u = users.get(id);
 u.setName(user.getName());
 u.setAge(user.getAge());
 users.put(id, u);
 return "success";
 }

 @ApiOperation(value="删除用户", notes="根据url的id来指定删除对象")
 @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
 @RequestMapping(value="/{id}", method=RequestMethod.DELETE)
 public String deleteUser(@PathVariable Long id) {
 users.remove(id);
 return "success";
 }
}
启动Spring Boot程序，访问：http://localhost:8080/swagger-ui.html

springboot 过滤器2种实现方式：

第一中实现方式：

/**
 * 1、@Component 这个注解的目的是将MyFilter交给容器来处理。也就是让MyFilter起作用
 2、@ServletComponentScan 这个使用来扫描@WebFilter 的让@WebFilter起作用。
   当然对于servlet线管注解也是可以的。这个@ServletComponentScan最好卸载Apllication这个上面，
   通用配置。我这里因为只有一个Filter所以没有写在Application上面。
 3、@WebFilter 这个用处显而易见，针对于什么链接做过滤，filter的名称是为什么。
 4、@Order(1)，filter执行优先级，值越小越优先
 */
@Order(1)
@Component
@ServletComponentScan
@WebFilter(urlPatterns = "/*",filterName = "MyFilter")
public class MyFilter implements Filter {
   @Override
   public void init(FilterConfig filterConfig) throws ServletException {

   }

   @Override
   public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
      throws IOException, ServletException {
      HttpServletRequest req = (HttpServletRequest) servletRequest;
      System.out.println("请求地址"+req.getRequestURI());
      filterChain.doFilter(servletRequest,servletResponse);

   }

   @Override
   public void destroy() {

   }
}
在application启动类添加注解：@ServletComponentScan
第二中实现方式： 
   实现Filter接口，实现Filter方法 

public class MyFilter implements Filter {
   @Override
   public void init(FilterConfig filterConfig) throws ServletException {

   }
   @Override
   public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
      throws IOException, ServletException {
      HttpServletRequest req = (HttpServletRequest) servletRequest;
      System.out.println("请求地址"+req.getRequestURI());
      filterChain.doFilter(servletRequest,servletResponse);

   }
   @Override
   public void destroy() {

   }
}

@Configuration//添加@Configuration 注解，将自定义Filter加入过滤链
public class ConfigurationFilter {
   @Bean
   public RemoteIpFilter remoteIpFilter() {
      return new RemoteIpFilter();
   }
   @Bean
   public FilterRegistrationBean testFilterRegistration() {
      FilterRegistrationBean registration = new FilterRegistrationBean();
      registration.setFilter(new MyFilter());//添加过滤器
      registration.addUrlPatterns("/*");//设置过滤路径，/*所有路径
      registration.addInitParameter("name", "alue");//添加默认参数
      registration.setName("MyFilter");//设置优先级
      registration.setOrder(1);//设置优先级
      return registration;
   }
}