Idea正則表達式一鍵替換註釋,生成@ApiModelProperty("")

平常日常開發中,返回給前端的vo對象在字段上需要加註釋@ApiModelProperty("xxx"),方便在前端同事在swagger文檔看註釋,一般我是domain對象生成之後,複製代碼到vo對象裏,然後再修改Java塊註釋爲前端的註釋@ApiModelProperty("xxx"),那怎麼從以下的代碼註釋轉爲@ApiModelProperty("xxx")註釋呢?如果字段很多的話,一個一個寫會比較耗時也枯燥,可以用正則表達式一鍵替。

    /**
     * xxx
     */

(1)domain對象

@Data
@Table
@Entity
public class FactoryOrder {

    /**
     * id
     */
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    /**
     * 訂單號
     */
    private String orderNum;

    /**
     * 訂單創建時間
     */
    private Long createTime;

    /**
     * 員工工號
     */
    private String staffId;

    /**
     * 員工名稱
     */
    private String staffName;

    /**
     * 訂單總金額
     */
    private Integer orderPrice;

    /**
     * 訂單類型
     */
    private String type;
}

(2)將字段複製到vo對象裏

@Data
public class FactoryOrderVO {

    /**
     * id
     */
    private Long id;

    /**
     * 訂單號
     */
    private String orderNum;

    /**
     * 訂單創建時間
     */
    private Long createTime;

    /**
     * 員工工號
     */
    private String staffId;

    /**
     * 員工名稱
     */
    private String staffName;

    /**
     * 訂單總金額
     */
    private Integer orderPrice;

    /**
     * 訂單類型
     */
    private String type;
}

(3)快捷鍵ctrl+r彈出替換代碼功能,選中Regex(此項爲使用正則表達式功能),接着在第一個框就可以寫正則表達式了,然後第二個框寫上要替換的內容即可,如圖可以看出已經框出了正則表達式所匹配的內容了,接着點擊Replace all即可全局替換爲@ApiModelProperty("xxx")。

  • 動態圖如下(可能有點慢,加載一下就好了 ^ ^):


(4)用到的正則表達式是這個:

\/\*\*\n *\* ([^\n]*)\n *\*\/

一般根據可以根據自己domain對象寫的註釋來寫對應的正則表達式,我簡單說一下我的這個正則表達式,這裏最主要是用了正則的(pattern)語法,即表達式捕獲註釋的內容,最後通過$1得到捕獲的註釋,寫到@ApiModelProperty("$1")來替換。
有關正則表達式入門的學習,可以看這個博主寫:正則表達式30分鐘入門教程,還有這個博主的總結:常用正則表達式,用的時候多看看就好了。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章