찾다

집  >  기사  >  Java  >  Java에서 가장 일반적으로 사용되는 주석을 요약합니다.

Java에서 가장 일반적으로 사용되는 주석을 요약합니다.

Y2J
Y2J원래의
2017-05-16 09:42:161583검색

본 글에서는 주로 스프링부트에서 사용되는 Annotation을 요약해서 소개하고 있으니 필요한 친구들은

@RestController, @RequestMapping Annotation

을 참고하면 된다. 4.0 중요 새로운 개선 사항은 @RestController 주석으로, 은 @Controller 주석에서 를 상속합니다. 버전 4.0 이전에는 Spring MVC 구성 요소는 모두 @Controller를 사용하여 현재 클래스를 Controllerservlet으로 식별했습니다. 이 기능을 사용하면 @Controller를 사용하지 않고 전용 @RestController를 사용하여 REST 서비스를 개발할 수 있습니다.

RESTful 웹 서비스를 구현하면 응답은 항상 응답 본문을 통해 전송됩니다. 개발을 단순화하기 위해 Spring 4.0은 컨트롤러의 특수 버전을 제공합니다. @RestController 구현의 정의를 살펴보겠습니다. 

@Target(value=TYPE)  
 @Retention(value=RUNTIME)  
 @Documented  
 @Controller  
 @ResponseBody  
public @interface RestController  
@Target(value=TYPE) 
 @Retention(value=RUNTIME) 
 @Documented 
 @Controller 
 @ResponseBody 
public @interface RestController

@RequestMapping 주석은 라우팅 정보를 제공합니다. 이는 "/" 경로에서 오는 모든 HTTP 요청이 home 메서드에 매핑되어야 함을 Spring에 알려줍니다. @RestController 주석은 Spring에게 결과를 string 형식으로 렌더링하고 호출자에게 직접 반환하도록 지시합니다.

참고: @RestController 및 @RequestMapping 주석은 Spring MVC 주석입니다(Spring Boot의 특정 부분이 아님)

@EnableAutoConfiguration 주석

두 번째 클래스 수준 주석은 @EnableAutoConfiguration입니다. 이 주석은 추가된 jar 종속성을 기반으로 Spring을 구성하려는 방법을 추측하도록 Spring Boot에 지시합니다. spring-boot-starter-web은 Tomcat과 Spring MVC를 추가하므로 자동 구성은 사용자가 웹 애플리케이션을 개발하고 있다고 가정하고 이에 따라 Spring을 설정합니다. 스타터 POM 및 자동 구성: 자동 구성을 설계하는 목적은 "스타터 POM"을 더 잘 활용하는 것이지만 두 개념은 직접적인 관련이 없습니다. 스타터 POM 외부에서 jar 종속성을 자유롭게 선택할 수 있으며 Spring Boot는 여전히 애플리케이션을 자동으로 구성하기 위해 최선을 다합니다.

@Configuration 클래스에 @EnableAutoConfiguration 또는 @SpringBootApplication 주석을 추가하여 자동 구성을 선택할 수 있습니다.

참고: @EnableAutoConfiguration 주석만 추가하면 됩니다. 기본 @Configuration 클래스에 추가하는 것이 좋습니다.

원하지 않는 특정 자동 구성 클래스가 적용된 경우 @EnableAutoConfiguration 주석의 제외 속성 을 사용하여 해당 클래스를 비활성화할 수 있습니다. 

<pre name="code" class="java">import org.springframework.boot.autoconfigure.*; 
import org.springframework.boot.autoconfigure.jdbc.*; 
import org.springframework.context.annotation.*; 
@Configuration 
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class}) 
public class MyConfiguration { 
} 
<pre name="code" class="java">import org.springframework.boot.autoconfigure.*;
import org.springframework.boot.autoconfigure.jdbc.*;
import org.springframework.context.annotation.*;
@Configuration
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
public class MyConfiguration {
}
@Configuration

Spring Boot는 Java 기반 구성을 옹호합니다. XML 소스를 사용하여 SpringApplication.run()을 호출할 수 있지만 일반적으로 @Configuration 클래스를 기본 소스로 사용하는 것이 좋습니다. 일반적으로 main 메서드를 정의하는 클래스는 기본 @Configuration의 좋은 후보이기도 합니다. 모든 @Configuration을 단일 클래스에 넣을 필요는 없습니다. @Import 주석을 사용하여 다른 구성 클래스를 가져올 수 있습니다. 또는 @ComponentScan 주석을 사용하여 @Configuration 클래스를 포함한 모든 Spring 구성 요소를 자동으로 수집할 수 있습니다.

XML 기반 구성을 꼭 사용해야 하는 경우에도 @Configuration 클래스로 시작하는 것이 좋습니다. 추가 @ImportResource 주석을 사용하여 XML구성 파일을 로드할 수 있습니다.

@SpringBootApplication 주석은 기본 속성과 함께 @Configuration, @EnableAutoConfiguration 및 @ComponentScan을 사용하는 것과 동일합니다. 

@ComponentScan(basePackages = "com.hyxt",includeFilters = {@ComponentScan.Filter(Aspect.class)}) 
@ComponentScan(basePackages = "com.hyxt",includeFilters = {@ComponentScan.Filter(Aspect.class)})
@SpringBootApplication

Spring Boot는 기본적으로 JSR-303을 사용하여(클래스 경로에 있는 경우) 외부 구성을 확인하려고 시도합니다. @ConfigurationProperties 클래스에 JSR-303 javax.validation

constraints

주석을 쉽게 추가할 수 있습니다. 

package com.example.myproject; 
import org.springframework.boot.SpringApplication; 
import org.springframework.boot.autoconfigure.SpringBootApplication; 
@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan  
public class Application { 
  public static void main(String[] args) { 
    SpringApplication.run(Application.class, args); 
  } 
} 
package com.example.myproject;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
public class Application {
  public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
  }
}

는 이 메서드의 반환 결과가 HTTP 응답 본문에 직접 기록된다는 의미입니다. 일반적으로 비동기적으로 데이터를 얻을 때 사용됩니다. @RequestMapping을 사용한 후 반환 값은 일반적으로

@responsebody를 추가한 후 반환 결과가 점프 경로로 구문 분석되지 않습니다. HTTP 응답 본문에 직접 기록됩니다. 예를 들어

는

json

데이터를 비동기적으로 가져오고, @responsebody를 추가하면 json 데이터가 직접 반환됩니다.


@Component:

泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。一般公共的方法我会用上这个注解

@AutoWired

byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构
造函数进行标注，完成自动装配的工作。

当加上（required=false）时，就算找不到bean也不报错。

@RequestParam：

用在方法的参数前面。

@RequestParam String a =request.getParameter("a")。 
@RequestParam String a =request.getParameter("a")。

@PathVariable:

路径变量。

RequestMapping("user/get/mac/{macAddress}") 
public String getByMacAddress(@PathVariable String macAddress){ 
//do something;  
} 
RequestMapping("user/get/mac/{macAddress}")
public String getByMacAddress(@PathVariable String macAddress){
//do something;
}

参数与大括号里的名字一样要相同。

以上注解的示范

/** 
 * 用户进行评论及对评论进行管理的 Controller 类； 
 */ 
@Controller 
@RequestMapping("/msgCenter") 
public class MyCommentController extends BaseController { 
  @Autowired 
  CommentService commentService; 
  @Autowired 
  OperatorService operatorService; 
  /** 
   * 添加活动评论； 
   * 
   * @param applyId 活动 ID； 
   * @param content 评论内容； 
   * @return 
   */ 
  @ResponseBody 
  @RequestMapping("/addComment") 
  public Map<String, Object> addComment(@RequestParam("applyId") Integer applyId, @RequestParam("content") String content) { 
    .... 
    return result; 
  } 
} 
/**
 * 用户进行评论及对评论进行管理的 Controller 类；
 */
@Controller
@RequestMapping("/msgCenter")
public class MyCommentController extends BaseController {
  @Autowired
  CommentService commentService;
  @Autowired
  OperatorService operatorService;
  /**
   * 添加活动评论；
   *
   * @param applyId 活动 ID；
   * @param content 评论内容；
   * @return
   */
  @ResponseBody
  @RequestMapping("/addComment")
  public Map<String, Object> addComment(@RequestParam("applyId") Integer applyId, @RequestParam("content") String content) {
    ....
    return result;
  }
}
@RequestMapping("/list/{applyId}") 
  public String list(@PathVariable Long applyId, HttpServletRequest request, ModelMap modelMap) { 
} 
 @RequestMapping("/list/{applyId}")
  public String list(@PathVariable Long applyId, HttpServletRequest request, ModelMap modelMap) {
}

全局处理异常的：

@ControllerAdvice：

包含@Component。可以被扫描到。

统一处理异常。

@ExceptionHandler（Exception.class）：

用在方法上面表示遇到这个异常就执行以下方法。

/** 
 * 全局异常处理 
 */ 
@ControllerAdvice 
class GlobalDefaultExceptionHandler { 
  public static final String DEFAULT_ERROR_VIEW = "error"; 
  @ExceptionHandler({TypeMismatchException.class,NumberFormatException.class}) 
  public ModelAndView formatErrorHandler(HttpServletRequest req, Exception e) throws Exception { 
    ModelAndView mav = new ModelAndView(); 
    mav.addObject("error","参数类型错误"); 
    mav.addObject("exception", e); 
    mav.addObject("url", RequestUtils.getCompleteRequestUrl(req)); 
    mav.addObject("timestamp", new Date()); 
    mav.setViewName(DEFAULT_ERROR_VIEW); 
    return mav; 
  }} 
/**
 * 全局异常处理
 */
@ControllerAdvice
class GlobalDefaultExceptionHandler {
  public static final String DEFAULT_ERROR_VIEW = "error";
  @ExceptionHandler({TypeMismatchException.class,NumberFormatException.class})
  public ModelAndView formatErrorHandler(HttpServletRequest req, Exception e) throws Exception {
    ModelAndView mav = new ModelAndView();
    mav.addObject("error","参数类型错误");
    mav.addObject("exception", e);
    mav.addObject("url", RequestUtils.getCompleteRequestUrl(req));
    mav.addObject("timestamp", new Date());
    mav.setViewName(DEFAULT_ERROR_VIEW);
    return mav;
  }}

通过@value注解来读取application.properties里面的配置

# face++ key 
face_api_key = R9Z3Vxc7ZcxfewgVrjOyrvu1d-qR**** 
face_api_secret =D9WUQGCYLvOCIdsbX35uTH******** 
# face++ key
face_api_key = R9Z3Vxc7ZcxfewgVrjOyrvu1d-qR****
face_api_secret =D9WUQGCYLvOCIdsbX35uTH********
@Value("${face_api_key}") 
  private String API_KEY; 
  @Value("${face_api_secret}") 
  private String API_SECRET; 
 @Value("${face_api_key}")
  private String API_KEY;
  @Value("${face_api_secret}")
  private String API_SECRET;所以一般常用的配置都是配置在application.properties文件的

【相关推荐】

1. 特别推荐：“php程序员工具箱”V0.1版本下载

2. Java免费视频教程

3. JAVA教程手册

위 내용은 Java에서 가장 일반적으로 사용되는 주석을 요약합니다.의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명：
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.
이전 기사：Java 주석 Spring Boot에 대한 튜토리얼다음 기사：Java 주석 Spring Boot에 대한 튜토리얼

관련 기사

더보기