Spring Mapper Swagger常用註解

2021-10-09 04:01:52 字數 1869 閱讀 4506

spring註解

註解說明

@bean

就是乙個已經例項化好的類

@autowired

可以用在字段、set 方法或構造方法上,它可以自動注入 spring 容器中存在的 bean。

@qualifier

和@autowired 配套使用,主要用於解決 bean 注入父類相同引起衝突的問題。@autowired @qualifier(「bean1」)

@configuration

實際上這個註解有點等同於 @component ,但是更多的是一種設計上的規範。通常在配置類上使用 @configuration 註解而不是 @component 註解。

@bean

該註解使用在方法上,該方法返回的 bean 會存到 spring 容器中。

@value

@component

有此註解的類 spring 會自動把這個類例項化放入容器。

@controller

@service

申明該類主要負責業務邏輯,例如註冊驗證儲存邏輯。

@repository

申明該類為持久層,用於處理與資料庫的 crud 操作,類似於 dao。

@controlleradvice

申明該類用於處理 controller 層丟擲的異常,大家可以在裡面自定義異常的處理流程。

@restcontroller

申明為 rest 版的控制器,在這個類中返回的內容 spring 會通過 jackson 自動轉換為 json 格式。

@restcontrolleradvice

與 @restcontroller 類似,是 @controlleradvice 的 rest 版。

@transactional

事務註解,如果裡面的 sql 操作出現異常,會自動進行回滾。

註解說明

@results

多個 @result 的集合,可以表示與資料庫某個表的整體對映關係,其中它的 id 可供 @resultmap 使用。詳情可以看上方的**。

@result

表中某字段與實體類某個欄位的對應關係。

@insert

對應 sql 的 insert 操作。

@delete

對應 sql 的 delete 操作。

@update

對應 sql 的 update 操作。

@select

對應 sql 的 select 操作,通常與 @resultmap 配合使用。

@resultmap

確定本 sql 語句與實體類的對應關係,其中 map id 需要事先通過 @results 宣告對應關係,詳情見上面的**。

@param

讓變數替換掉 sql 語句中的 #,例如 @param(「username」) string data ,假設 data 的值為 smith 。 @param 註解可以把 sql 語句由 select * from user where username=# 變為 select * from user where username=『smith』 。

swagger註解

註解說明

@api

用在請求的類上,表示對類的說明,也代表了這個類會出現在 swagger 上

@apioperation

用在方法上,表示乙個 http 請求訪問該方法的操作

@apimodel

用於響應實體類上,用於說明實體作用

@apiimplicitparams

@apilmplicitparam 的集合

@apilmplicitparam

用在方法上,指定某個請求引數的內容

@apiignore

用在類或方法上,標明忽略此介面

Entity framework 常用資料註解

命名空間 system.componentmodel.dataannotations key該列為主鍵 databasegenerated databasegeneratedoption.none 指定該列不從資料庫中生成 required required errormessage 不能為空 該列...

Doxygen Doxygen簡介和常用注釋

exception 對乙個異常物件進行注釋。warning 一些需要注意的事情 todo 對將要做的事情進行注釋,鏈結到所有todo 彙總的todo 列表 bug 缺陷,鏈結到所有缺陷彙總的缺陷列表 see 一段包含其他部分引用的注釋,中間包含對其他 項的名稱,自動產生對其的引用鏈結。relates...

Swagger 三 Swagger中常用的注釋

api 用在請求的類上,表示對類的說明 tags 說明該類的作用,可以在ui介面上看到的註解 description 描述 比如 api tags 第乙個controller層 description 用來測試資料 2.apioperation 用在請求的方法上,說明方法的用途 作用 value 說...