Idea正則表達(dá)式一鍵替換注釋?zhuān)葽ApiModelProperty("")

平常日常開(kāi)發(fā)中,返回給前端的vo對(duì)象在字段上需要加注釋@ApiModelProperty("xxx"),方便在前端同事在swagger文檔看注釋?zhuān)话阄沂莇omain對(duì)象生成之后,復(fù)制代碼到vo對(duì)象里,然后再修改Java塊注釋為前端的注釋@ApiModelProperty("xxx"),那怎么從以下的代碼注釋轉(zhuǎn)為@ApiModelProperty("xxx")注釋呢?如果字段很多的話,一個(gè)一個(gè)寫(xiě)會(huì)比較耗時(shí)也枯燥,可以用正則表達(dá)式一鍵替。

    /**
     * xxx
     */

(1)domain對(duì)象

@Data
@Table
@Entity
public class FactoryOrder {

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

    /**
     * 訂單號(hào)
     */
    private String orderNum;

    /**
     * 訂單創(chuàng)建時(shí)間
     */
    private Long createTime;

    /**
     * 員工工號(hào)
     */
    private String staffId;

    /**
     * 員工名稱(chēng)
     */
    private String staffName;

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

    /**
     * 訂單類(lèi)型
     */
    private String type;
}

(2)將字段復(fù)制到vo對(duì)象里

@Data
public class FactoryOrderVO {

    /**
     * id
     */
    private Long id;

    /**
     * 訂單號(hào)
     */
    private String orderNum;

    /**
     * 訂單創(chuàng)建時(shí)間
     */
    private Long createTime;

    /**
     * 員工工號(hào)
     */
    private String staffId;

    /**
     * 員工名稱(chēng)
     */
    private String staffName;

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

    /**
     * 訂單類(lèi)型
     */
    private String type;
}

(3)快捷鍵ctrl+r彈出替換代碼功能,選中Regex(此項(xiàng)為使用正則表達(dá)式功能),接著在第一個(gè)框就可以寫(xiě)正則表達(dá)式了,然后第二個(gè)框?qū)懮弦鎿Q的內(nèi)容即可,如圖可以看出已經(jīng)框出了正則表達(dá)式所匹配的內(nèi)容了,接著點(diǎn)擊Replace all即可全局替換為@ApiModelProperty("xxx")。

  • 動(dòng)態(tài)圖如下(可能有點(diǎn)慢,加載一下就好了 ^ ^):


    正則表達(dá)式替換動(dòng)圖.gif
正則表達(dá)式替換_1.png
正則表達(dá)式替換_2.png

(4)用到的正則表達(dá)式是這個(gè):

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

一般根據(jù)可以根據(jù)自己domain對(duì)象寫(xiě)的注釋來(lái)寫(xiě)對(duì)應(yīng)的正則表達(dá)式,我簡(jiǎn)單說(shuō)一下我的這個(gè)正則表達(dá)式,這里最主要是用了正則的(pattern)語(yǔ)法,即表達(dá)式捕獲注釋的內(nèi)容,最后通過(guò)$1得到捕獲的注釋?zhuān)瑢?xiě)到@ApiModelProperty("$1")來(lái)替換。
有關(guān)正則表達(dá)式入門(mén)的學(xué)習(xí),可以看這個(gè)博主寫(xiě):正則表達(dá)式30分鐘入門(mén)教程,還有這個(gè)博主的總結(jié):常用正則表達(dá)式,用的時(shí)候多看看就好了。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容