快捷導(dǎo)航

關(guān)于springboot忽略接口,參數(shù)注解的使用ApiIgnore

更新時間：2024年07月16日 09:36:50 作者：大佬腿好粗

這篇文章主要介紹了關(guān)于springboot忽略接口,參數(shù)注解的使用ApiIgnore,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

springboot忽略接口,參數(shù)注解的使用ApiIgnore

在這里插入圖片描述

作用在方法上，忽略此方法，不在頁面展示
作用在類上，忽略此接口下所有方法，不在頁面展示
作用在參數(shù)上，忽略接口調(diào)用時的調(diào)用參數(shù)

list(@ApiIgnore @RequestParam Map<String, Object> params)

實體類忽略參數(shù)

@ApiModelProperty(value = "創(chuàng)建者",hidden = true)

或

@ApiModelProperty(value = "創(chuàng)建者")
@JsonIgnore

springboot的常用注解

提示：這里可以添加本文要記錄的大概內(nèi)容：

注解式編程目前在業(yè)內(nèi)廣泛使用，這里例舉了部分Spring Boot項目中常用的一些注解，結(jié)合項目應(yīng)用，后面還會逐步添加，有需要可以收藏

注解大全

序號	注解	所屬框架	作用
1	@ComponentScan	Spring	添加在配置類上的，配置組件掃描，如果配置此注解的value屬性，可指定組件掃描的根包（basePackages）
2	@Component	Spring	添加在類上，表示當(dāng)前類是一個組件，但并不能直接確定是哪一種組件
3	@Controller	Spring	添加在類上，表示當(dāng)前類是一個組件，建議添加在控制器類上（冗余），可被替代@RestController
4	@Service	Spring	添加在類上，表示當(dāng)前類是一個組件，建議添加在處理業(yè)務(wù)邏輯的類上
5	@Repository	Spring	添加在類上，表示當(dāng)前類是一個組件，建議添加在數(shù)據(jù)訪問層的類上
6	@Configuration	Spring	添加在類上，表示當(dāng)前類是一個配置類
7	@Scope	Spring	添加在組件類上，或添加在@Bean方法上，通過配置參數(shù)prototype將Spring管理此對象調(diào)整為“非單例”，不建議使用
8	@Lazy	Spring	添加在組件類上，或添加在@Bean方法上，將Spring管理此對象調(diào)用為“懶加載”，不建議使用
9	@PostConstruct	Spring	這是javax.annotation包中的注解，添加在生命周期方法上，表示此方法是“創(chuàng)建后”的方法（初始化方法），一般不用
10	@PreDestroy	Spring	這是javax.annotation包中的注解，添加在生命周期方法上，表示此方法是“銷毀前”的方法（銷毀方法），一般不用
11	@Autowired	Spring	添加在屬性上、方法上、構(gòu)造方法上，表示Spring框架將為此屬性自動裝配，或自動調(diào)用對應(yīng)的方法
12	@Bean	Spring	在配置類中，自定義某個方法，其返回值類型就是你需要Spring創(chuàng)建對象的類型，在方法體中自行編寫創(chuàng)建對象的代碼，并且，在此方法上添加@Bean注解即可
13	@Qualifier	Spring	添加在屬性上、方法的參數(shù)上，與@Autowired匹配使用，當(dāng)嘗試自動裝配的數(shù)據(jù)有多個匹配類型的Spring Bean，但名稱并不匹配，可以使用此注解指定使用特定名稱的Spring Bean，一般不用
14	@Resource	Spring	這是javax.annotation包中的注解，添加在屬性上，表示Spring框架將為此屬性自動裝配，當(dāng)嘗試自動裝配的數(shù)據(jù)有多個匹配類型的Spring Bean，可以配置此注解的name屬性，用于指定使用特定名稱的Spring Bean
15	@ResponseBody	Spring MVC	添加在方法上、控制器類上，表示此方法或此控制器中所有方法在響應(yīng)時，都是響應(yīng)正文的
16	@RestController	Spring MVC	添加在控制器類上，表示此類是一個控制器類，并且，此類中所有方法在響應(yīng)時，都是響應(yīng)正文的，它的元注解中包含@ResponseBody和@Controller
17	@RequestMapping	Spring MVC	添加在方法上、控制器類上，主要用于配置請求路徑，及某些參數(shù)，開發(fā)中更多的用于添加在控制器類上，指定請求的父路徑。
18	@GetMapping	Spring MVC	添加在方法上，只接收GET方式的請求，主要用于配置請求路徑，其它參數(shù)的配置與@RequestMapping相同
19	@PostMapping	Spring MVC	添加在方法上，只接收POST方式的請求，主要用于配置請求路徑，其它參數(shù)的配置與@RequestMapping相同
20	@PutMapping	Spring MVC	添加在方法上，只接收PUT方式的請求，主要用于配置請求路徑，其它參數(shù)的配置與@RequestMapping相同
21	@DeleteMapping	Spring MVC	添加在方法上，只接收DELETE方式的請求，主要用于配置請求路徑，其它參數(shù)的配置與@RequestMapping相同
22	@RequestBody	Spring MVC	添加在處理請求的方法的參數(shù)上，用于要求客戶端使用JSON格式來提交請求參數(shù)
23	@PathVariable	Spring MVC	添加在處理請求的方法的參數(shù)上，用于接收URL中使用{}格式占位符對應(yīng)的參數(shù)，如果{}占位符名稱與方法的參數(shù)名稱不同，還可以在此注解中配置{}占位符名稱，用于解決名稱不一致的問題
24	@RequestParam	Spring MVC	添加在處理請求的方法的非封裝類型的參數(shù)上，用于指定請求參數(shù)名稱、限制必須提交、配置默認(rèn)值
25	@Validated	Spring MVC	添加在處理請求的方法的參數(shù)上，添加spring-boot-starter-validation依賴，対DTO請求參數(shù)進(jìn)行驗證
26	@NotNull	Spring MVC	與@Validated配合使用，作用在數(shù)據(jù)傳輸對象類屬性上，要求傳輸數(shù)據(jù)不能為空。
27	@Range	Spring MVC	與@Validated配合使用，作用在數(shù)據(jù)傳輸對象類屬性上，対傳輸數(shù)據(jù)范圍提出要求。
28	@ControllerAdvice	Spring MVC	添加在全局處理異常類上，此類中的特定方法會在每次處理異常請求時被調(diào)用（冗余）
29	@RestControllerAdvice	Spring MVC	添加在全局處理異常類上，此類中的特定方法會在每次處理請求時被調(diào)用，并且，如果這些方法會進(jìn)行響應(yīng)，會是響應(yīng)正文的，此注解使用了@ResponseBody和@ControllerAdvice作為元注解
30	@ExceptionHandler	Spring MVC	添加在處理異常的方法上，表示此方法是處理異常的。
31	@MapperScan	Mybatis	添加在配置類上，用于指定Mapper接口所在的包，在啟動項目時，Mybatis框架會生成這些接口的代理對象。
32	@Param	Mybatis	添加在Mapper接口的抽象方法的參數(shù)上，用于指定參數(shù)名稱，在SQL語句中將可以通過#{}占位符且大括號使用配置的參數(shù)名稱，來表示SQL語句中的參數(shù)，不采用
*	@PostConstruct		Java自帶的注解，在方法上加該注解會在項目啟動的時候執(zhí)行該方法，在Mybatis配置類中創(chuàng)建添加攔截器方法
33	@EnableSwagger2WebMvc	Swagger	添加在配置類上，開啟生成全局API文檔
34	@Api	Swagger	添加在控制器類上，表示對類的說明，也代表了這個類是swagger2 的資源，參數(shù).tags: 說明該類的作用
35	@ApiOperation	Swagger	添加在方法上，表示一個http 請求訪問該方法的操作，參數(shù)： value=“方法的用途和作用”
36	@ApiOperationSupport	Swagger	添加在方法上，配置方法的排序位置，參數(shù)：order
37	@ApiImplicitParam	Swagger	添加在方法上，表示單獨的請求參數(shù)，用于対API文檔時対請求參數(shù)進(jìn)行說明。
38	@ApiImplictParams	Swagger	用在請求的方法上，包含多@ApliImplictParam，一般不會用到，當(dāng)有多個參數(shù)時，常進(jìn)行封裝。
39	@ApiModelProperty	Swagger	添加在實體類的屬性上，対屬性進(jìn)行描述，參數(shù)：value，example，required。
40	@ApiIgnore	Swagger	添加在類、方法上或方法參數(shù)前面，不顯示在文檔頁面上
41	@Data	Lombok	添加在POJO類上，要求此類的父類中存在無參數(shù)構(gòu)造方法。幫助生成所有屬性對應(yīng)的Setters & Getters、規(guī)范的hashCode()和equals()、toString()
42	@Getter	Lombok	Lombok也提供相應(yīng)的@Setter，@ToString，@EqualsAndHashCode注解，用在無法使用@Data注解的類上使用。
43	@Slf4j	Lombok	添加在類上，用于添加日志
44	@EnableGlobalMethodSecurity	Security	添加在Security配置類上，用于開啟全局方法權(quán)限檢查，參數(shù)：prePostEnabled
45	@PreAuthorize	Security	配置在業(yè)務(wù)方法上，用于対業(yè)務(wù)進(jìn)行授權(quán)，只有擁有權(quán)限才能調(diào)用方法，參數(shù)：value = “hasAuthority(“xxx”)”
45+	@AuthenticationPrincipal	Security	用于訪問控制器中當(dāng)前經(jīng)過身份驗證的用戶。添加在需要方法參數(shù)前，封裝當(dāng)前登錄用戶信息
46	@Transactional	Spring	開啟事務(wù)關(guān)聯(lián)管理，建議添加在業(yè)務(wù)接口上
47	@Value	Spring	將與配置文件中的鍵對應(yīng)的值分配給其帶注解的屬性
48	@EnableScheduling	Spring	添加在配置類上，開啟計劃調(diào)度功能
49	@Scheduled	Spring	執(zhí)行計劃任務(wù)，添加在方法上，要使用@Scheduled注解，首先需要在啟動類添加@EnableScheduling，啟用Spring的計劃任務(wù)執(zhí)行功能，這樣可以在容器中的任何Spring管理的bean上檢測@Scheduled注解，執(zhí)行計劃任務(wù)
50	@JsonFormat	JJWT	時間格式化注解，添加在時間屬性上
51	@DubboService	Dubbo	注解標(biāo)記的業(yè)務(wù)邏輯層實現(xiàn)類,其中的所有方法會注冊到Nacos, 其它服務(wù)在"訂閱"時,就會"發(fā)現(xiàn)"當(dāng)前項目提供的服務(wù)(業(yè)務(wù)邏輯層方法),以便后續(xù)在需要時調(diào)用
52	@EnableDubbo	Dubbo	如果當(dāng)前項目是Dubbo的生產(chǎn)者,必須在當(dāng)前項目的SpringBoot啟動類上添加下面注解,才能正常正確的將當(dāng)前項目提供的服務(wù)注冊到Nacos
53	@DubboReference	Dubbo	表示當(dāng)前業(yè)務(wù)邏輯層代碼,要消費其它模塊的服務(wù),可以編寫當(dāng)前Nacos中注冊的其它模塊的業(yè)務(wù)邏輯層接口,因為在Nacos中注冊的是接口的實現(xiàn)類,可以實現(xiàn)自動裝配實現(xiàn)類的效果
54	@GlobalTransactional	Seata	編寫@GlobalTransactional標(biāo)記方法，就相當(dāng)于設(shè)置了分布式事務(wù)的起點,當(dāng)前模塊就是分布式事務(wù)模型中的TM，最終效果是由當(dāng)前方法調(diào)用的所有遠(yuǎn)程服務(wù)中對數(shù)據(jù)庫的操作要么都執(zhí)行,要么都不執(zhí)行
55	@SentinelResource	Sentinel	@SentinelResource注解標(biāo)記的控制層方法,會在運行時被Sentinel進(jìn)行管理，在這個控制層方法第一次運行后,可以在Sentinel儀表臺界面中設(shè)置限流規(guī)則，參數(shù)：value設(shè)置當(dāng)前方法在儀表臺顯示的名稱，blockHandler指定限流時運行方法的配置，fallback 當(dāng)控制器方法運行發(fā)生異常時,運行的降級方法的名稱