SpringBoot专题

1.常用注解

一、创建对象相关注解

@Controller: 放在类的上面，创建控制器对象，注入到容器中。

@RestController: 复合注解@Controller , @ResponseBody, 使用这个注解类的，里面的控制器方法的返回值都是数据

@Service ：放在业务层的实现类上面，创建service对象，注入到容器

@Repository : 放在dao层的实现类上面，创建dao对象，放入到容器。在使用MyBatis框架， dao对象是MyBatis通过代理生成的。不需要使用@Repository、 所以没有使用。

@Component: 放在类的上面，创建此类的对象，放入到容器中。

二、赋值注解

@Value ：简单类型的赋值， 使用@Value,获取配置文件者的数据（properties或yml）。

@Controller
public class HelloSpringBoot {

    @Value("${server.port}")
    private Integer port;
    
    @RequestMapping("/hello")
    @ResponseBody
    public String helloSpringBoot() {
        return "欢迎使用SpringBoot框架:" + port;
    }
}

@Autowired: 引用类型赋值自动注入的，支持byName, byType（默认）。 放在属性的上面，也可以放在构造。
@Resource ：来自jdk中的定义， javax.annotation。实现引用类型的自动注入， 支持byName(默认), byType, 如果byName失败， 再使用byType注入。在属性上面使用。

三、Springboot注解

@SpringBootApplication ：放在启动类上面，
复合注解包含了@SpringBootConfiguration，@EnableAutoConfiguration，@ComponentScan

四、Mybatis注解

@Mapper ：放在类的上面 ， 让MyBatis找到接口， 创建他的代理对象

@MapperScan :放在主类的上面 ， 指定扫描的包， 把这个包中的所有接口都创建代理对象。对象注入到容器中

@Param ：放在dao接口的方法的形参前面， 作为命名参数使用的。

五、Dubbo注解

@DubboService: 在提供者端使用的，暴露服务的， 放在接口的实现类上面

@DubboReference: 在消费者端使用的， 引用远程服务， 放在属性上面使用。

@EnableDubbo : 放在主类上面， 表示当前引用启用Dubbo功能。

六、其他注解

@Configuration ：放在类的上面，表示这是个配置类，相当于xml配置文件。

@Bean：放在方法的上面， 把方法的返回值对象，注入到spring容器中。

@ImportResource ：加载其他的xml配置文件， 把文件中的对象注入到spring容器中。

@PropertySource ：读取其他的properties属性配置文件。

@ComponentScan：扫描器 ，指定包名，扫描注解的。

@ResponseBody: 放在方法的上面，表示方法的返回值是数据， 不是视图。

@RequestBody : 把请求体中的数据，读取出来， 转为java对象使用。

@ControllerAdvice: 控制器增强， 放在类的上面， 表示此类提供了方法，可以对controller增强功能。

@ExceptionHandler : 处理异常的，放在方法的上面。

@Transcational : 处理事务的， 放在service实现类的public方法上面， 表示此方法有事务。

2.springboot使用拦截器

一、Springboot引入mvc

引入相关pom文件

  <!--web依赖-->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

二、定义拦截器

自定义类实现HandlerInterceptor

public interface HandlerInterceptor {
    default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }

    default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
    }

    default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
    }
}

例：登录拦截器

public class LoginInterceptor implements HandlerInterceptor  {
/**
     * true： 请求能被Controller处理
     * false: 请求被截断
     */
    @Override
    public boolean preHandle(HttpServletRequest request,
                             HttpServletResponse response,
                             Object handler) throws Exception {
        String uri = request.getRequestURI();
        System.out.println("执行了LoginInterceptor的preHandle" + uri);
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        String uri = request.getRequestURI();
        System.out.println("执行了LoginInterceptor的postHandle" + uri);
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        String uri = request.getRequestURI();
        System.out.println("执行了LoginInterceptor的afterCompletion" + uri);
    }
    
}

拦截器方法执行顺序：preHandle->(true)postHandle->afterCompletion

三、配置拦截规则

需实现WebMvcConfigurer接口
addInterceptor：增加拦截器；
addPathPatterns：增加拦截规则路径；
excludePathPatterns：排除拦截规则路径；

@Configuration
public class MyAppConfig implements WebMvcConfigurer {

    //添加拦截器对象， 注入到容器中
    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        //创建拦截器对象
        HandlerInterceptor interceptor = new LoginInterceptor();

        //指定拦截的请求uri地址
        String path []= {"/user/**"};
        //指定不拦截的地址
        String excludePath  [] = {"/user/login"};
        registry.addInterceptor(interceptor)
                .addPathPatterns(path)
                .excludePathPatterns(excludePath);

    }
}

四、测试

测试：手写controller

 @RequestMapping("/user/account")
    @ResponseBody
    public String userAccount(){
        return "访问user/account地址";
    }

    @RequestMapping("/user/login")
    @ResponseBody
    public String userLogin(){
        return "访问user/login地址";
    }

访问：http://localhost:8080/user/account

2.springboot使用过滤器

一、Springboot引入mvc

引入相关pom文件

 <!--web依赖-->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

二、定义过滤器

自定义类实现Filter,重写doFilter方法处理过滤逻辑。

public class MyFitler implements Filter {
    /**
     * init()方法用于Filter的初始化
     */
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("执行了Filter的init()方法...");
    }
    /**
     * doFilter()方法用于Filter的拦截
     */
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        System.out.println("执行了Filter的doFilter()方法...");        
        chain.doFilter(request, response);
    }
    /**
     * destory()方法用于Filter的销毁
     */
    public void destroy() {
        System.out.println("执行了Filter的destroy()方法...");
    }
}

三、注册过滤器

在springmvc项目中，需在web.xml配置拦截路径规则

<!-- 配置过滤器 -->
  <filter>
      <!-- 配置过滤器的名称 -->
      <filter-name>MyFitler</filter-name>
      <!-- 配置对应过滤器类的完整路径 -->
      <filter-class>app.java.fitler.MyFitler</filter-class>
  </filter>
  <!-- 配置过滤器的拦截路径 -->
  <filter-mapping>
      <!-- 配置过滤器的名称 -->
      <filter-name>MyFitler</filter-name>
      <!-- 配置过滤器的拦截的路径 -->
      <url-pattern>/*</url-pattern>
  </filter-mapping> 

在springboot项目中也是自定义类，实现Filter接口，而配置只需要将FilterRegistrationBean注册到容器。

//注册Filter
    @Bean
    public FilterRegistrationBean filterRegistrationBean(){
        FilterRegistrationBean reg = new FilterRegistrationBean();
        //使用框架中的过滤器类
        MyFitler filter  = new MyFitler(); 
        reg.setFilter(filter);
        //指定 过滤的url地址
        reg.addUrlPatterns("/*"); 
        return reg;
    }