検索

ホームページ >Java >＆＃＆チュートリアル >Java で最も一般的に使用されるアノテーションのいくつかを要約します。

Java で最も一般的に使用されるアノテーションのいくつかを要約します。

Y2J
Y2Jオリジナル
2017-05-16 09:42:161587ブラウズ

この記事では、主に Spring Boot で使用される一般的なアノテーションの概要を紹介します。必要な方は、

@RestController および @RequestMapping アノテーションを参照してください。

4.0 の重要な新しい改善点は、@RestController アノテーションです。 @Controller アノテーションから継承します。バージョン 4.0 より前では、Spring MVC コンポーネントはすべて @Controller を使用して現在のクラスを controllerサーブレット として識別していました。この機能を使用すると、@Controller を使用せずに専用の @RestController を使用して REST サービスを開発できます。

RESTful Web サービスを実装すると、応答は常に応答本文を通じて送信されます。開発を簡素化するために、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 リクエストをホーム メソッドにマッピングする必要があることを Spring に伝えます。 @RestController アノテーションは、結果を string としてレンダリングし、呼び出し元に直接返すように Spring に指示します。

注: @RestController および @RequestMapping アノテーションは Spring MVC アノテーションです (これらは Spring Boot の特定の部分ではありません)

@EnableAutoConfiguration アノテーション

2 番目のクラスレベルのアノテーションは @EnableAutoConfiguration です。このアノテーションは、追加された jar 依存関係に基づいて Spring をどのように構成するかを推測するように Spring Boot に指示します。 spring-boot-starter-web は Tomcat と Spring MVC を追加するため、自動構成では Web アプリケーションを開発していると想定され、それに応じて Spring がセットアップされます。スターター POM と自動構成: 自動構成を設計する目的は、「スターター POM」をより有効に活用することですが、2 つの概念は直接関係しません。スターター POM 以外の jar 依存関係を自由に選択でき、Spring Boot は引き続きアプリケーションを自動的に構成するために最善を尽くします。

@EnableAutoConfiguration または @SpringBootApplication アノテーションを @Configuration クラスに追加することで、自動構成を選択できます。


注: @EnableAutoConfiguration アノテーションを追加するだけで済みます。これをメインの @Configuration クラスに追加することをお勧めします。

必要のない特定の自動構成クラスが適用されていることがわかった場合は、 @EnableAutoConfiguration アノテーションの exclude

属性 を使用してそれらを無効にすることができます。 

<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 を 1 つのクラスに入れる必要はありません。 @Import アノテーションを使用して、他の構成クラスをインポートできます。あるいは、 @ComponentScan アノテーションを使用して、@Configuration クラスを含むすべての Spring コンポーネントを自動的に収集することもできます。

XML ベースの構成を使用する必要がある場合でも、@Configuration クラスから始めることをお勧めします。追加の @Import

Resource アノテーションを使用して、XML設定ファイルをロードできます。

このクラスの @Configuration アノテーションは、XML で Bean を構成することと同等です。@Bean アノテーション メソッドを使用することは、XML で Bean を構成することと同等です

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

多くの Spring Boot 開発者は、メイン クラスにアノテーションを付けるために常に @Configuration、@EnableAutoConfiguration、および @ComponentScan を使用します。 。これらのアノテーションは非常に頻繁に一緒に使用されるため (特に上記のベスト プラクティスに従う場合)、Spring Boot は便利な @SpringBootApplication の代替手段を提供します。

@SpringBootApplication アノテーションは、 @Configuration 、 @EnableAutoConfiguration 、および @ComponentScan をデフォルトのプロパティで使用するのと同等です。 

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);
  }
}

Spring Boot は、デフォルトで JSR-303 (クラスパス上にある場合) を使用して、外部構成を検証しようとします。 JSR-303 javax.validation を @ConfigurationProperties クラスに簡単に追加できます

Constraintアノテーション: 

@Component 
@ConfigurationProperties(prefix="connection") 
public class ConnectionSettings { 
@NotNull 
private InetAddress remoteAddress; 
// ... getters and setters  
} 
@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
@NotNull
private InetAddress remoteAddress;
// ... getters and setters
}
@Profiles
Spring Profiles提供了一种隔离应用程序配置的方式，并让这些配置只能在特定的环境下生效。任何@Component或@Configuration都能被@Profile标记，从而限制加载它的时机。
[java] view plain copy print?在CODE上查看代码片派生到我的代码片
@Configuration 
@Profile("production") 
public class ProductionConfiguration { 
// ...  
} 
@Configuration
@Profile("production")
public class ProductionConfiguration {
// ...
}@ResponseBody

このメソッドの戻り結果が HTTP 応答本文に直接書き込まれることを示します

通常、データを非同期で取得するときに使用されます。 @RequestMapping の後、戻り値は通常、ジャンプ パスとして解析されます。

@responsebody を追加すると、戻り値はジャンプ パスとして解析されず、HTTP 応答本文に直接書き込まれます。たとえば、

json
dataを非同期で取得し、@responsebodyを追加すると、jsonデータが直接返されます。

@コンポーネント:

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

@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 中国語 Web サイトの他の関連記事を参照してください。

声明：
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
前の記事：Java アノテーション Spring Boot のチュートリアル次の記事：Java アノテーション Spring Boot のチュートリアル

関連記事

続きを見る