基於SpringBoot從零構建博客網站 - 整合lombok和mybatis-plus提高開發效率


在上一章節中《技術選型和整合開發環境》,確定了開發的技術,但是如果直接這樣用的話,可能開發效率會不高,為了提高開發的效率,這里再整合lombok和mybatis-plus兩個組件。

1、lombok

以前在Github上看到過lombok,但是也沒有進一步了解它的作用。前幾天用了一下,感覺代碼清爽多了,確時覺得利用lombok可以簡化代碼提高開發效率的。

lombok的官網為https://projectlombok.org/,官網上對它介紹如下:

Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.
Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.

大概意思就是:

Lombok是一種Java™實用工具,可用來幫助開發人員消除Java的冗長代碼,尤其是對於簡單的Java對象(POJO),它通過注釋實現這一目的。

要使用lombok這個工具,首先要為開發工具安裝相應插件,以eclipse為例:

(1)、到官網下載lombok.jar

(2)、雙擊lombok.jar文件,出現如下畫面:

點擊“Specify location...”按鈕,找到eclipse的運行文件eclipse.exe

(3)、安裝完成,重啟eclipse即可。

(4)、如果是maven管理工程,只需要在pom文件加入:

<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<optional>true</optional>
</dependency>

注意:由於本人這邊是基於spring boot的,所以lombok沒有加版本號,如果你這邊不是基於spring boot就要加上相應的版本號。

lombok提供注解有:

  • @Setter:注解在屬性上;為屬性提供 setting 方法
  • @Getter:注解在屬性上;為屬性提供 getting 方法
  • @NoArgsConstructor:注解在類上;為類提供一個無參的構造方法
  • @AllArgsConstructor:注解在類上;為類提供一個全參的構造方法
  • @ToString:注解在類上;生成對應的 toString 方法
  • @EqualsAndHashCode:注解在類上;生成對應的 equals 和 hashCode 方法
  • @RequiredArgsConstructor:注解在類上;會生成一個包含常量,和標識了NotNull的變量的構造方法
  • @Data:注解在類上;等同於@Getter、@Setter、@RequiredArgsConstructor、@ToString和@EqualsAndHashCode一起的效果
  • @Log4j/@Slf4j:注解在類上;生成對應的 Logger 對象,變量名為 log

當然還有一些注解,此處就不在介紹,大家可以自行查看官網信息。

舉例說明:

比如:寫一個Config的domain對象,從上一節章節可知,該對象有3個屬性分別是configId、configValue和description,如果是按着原來的寫法是:

package com.swnote.common.domain;

import java.io.Serializable;

/**
 * 站點相關配置信息
 * 
 * @author lzj
 * @since 1.0
 * @date [2019-04-04]
 */
public class Config implements Serializable {
    private static final long serialVersionUID = 8241975875344125491L;

    /**
     * 配置項key
     */
    private String configId;

    /**
     * 配置項value
     */
    private String configValue;

    /**
     * 描述
     */
    private String description;

    public String getConfigId() {
        return configId;
    }

    public void setConfigId(String configId) {
        this.configId = configId;
    }

    public String getConfigValue() {
        return configValue;
    }

    public void setConfigValue(String configValue) {
        this.configValue = configValue;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

但是如果使用lombok后,就變成如下:

package com.swnote.common.domain;

import java.io.Serializable;

import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 站點相關配置信息
 * 
 * @author lzj
 * @since 1.0
 * @date [2019-04-04]
 */
@Data
@NoArgsConstructor
public class Config implements Serializable {
    private static final long serialVersionUID = 8241975875344125491L;

    /**
     * 配置項key
     */
    private String configId;

    /**
     * 配置項value
     */
    private String configValue;

    /**
     * 描述
     */
    private String description;
}

代碼明顯變得更加簡潔了,只加了@Data和@NoArgsConstructor兩個注解,就達到跟上面一樣的效果,省去Getter和Getter代碼,但是這個同樣有Getter和Getter方法,這就是lombok插件幫我們加上相應的代碼。

2、mybatis-plus

如果直接使用mybatis作為持久化層框架的話,那么對每條SQL都得寫在相應的mapper文件里面,這也很麻煩的。然而mybatis-plus是在MyBatis的基礎上只做增強不做改變,為簡化開發、提高效率而生。官網在是https://mp.baomidou.com,它的特性有:

  • 無侵入:只做增強不做改變,引入它不會對現有工程產生影響,如絲般順滑
  • 損耗小:啟動即會自動注入基本 CURD,性能基本無損耗,直接面向對象操作
  • 強大的 CRUD 操作:內置通用 Mapper、通用 Service,僅僅通過少量配置即可實現單表大部分 CRUD 操作,更有強大的條件構造器,滿足各類使用需求
  • 支持 Lambda 形式調用:通過 Lambda 表達式,方便的編寫各類查詢條件,無需再擔心字段寫錯
  • 支持多種數據庫:支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer 等多種數據庫
  • 支持主鍵自動生成:支持多達 4 種主鍵策略(內含分布式唯一 ID 生成器 - Sequence),可自由配置,完美解決主鍵問題
  • 支持 XML 熱加載:Mapper 對應的 XML 支持熱加載,對於簡單的 CRUD 操作,甚至可以無 XML 啟動
  • 支持 ActiveRecord 模式:支持 ActiveRecord 形式調用,實體類只需繼承 Model 類即可進行強大的 CRUD 操作
  • 支持自定義全局通用操作:支持全局通用方法注入( Write once, use anywhere )
  • 支持關鍵詞自動轉義:支持數據庫關鍵詞(order、key......)自動轉義,還可自定義關鍵詞
  • 內置代碼生成器:采用代碼或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 層代碼,支持模板引擎,更有超多自定義配置等您來使用
    內置分頁插件:基於 MyBatis 物理分頁,開發者無需關心具體操作,配置好插件之后,寫分頁等同於普通 List 查詢
  • 內置性能分析插件:可輸出 Sql 語句以及其執行時間,建議開發測試時啟用該功能,能快速揪出慢查詢
    內置全局攔截插件:提供全表 delete 、 update 操作智能分析阻斷,也可自定義攔截規則,預防誤操作
    內置 Sql 注入剝離器:支持 Sql 注入剝離,有效預防 Sql 注入攻擊

整合mybatis-plus:

(1)、pom文件中加入相應依賴:

<dependency>
	<groupId>com.baomidou</groupId>
	<artifactId>mybatis-plus-boot-starter</artifactId>
	<version>3.1.0</version>
</dependency>

(2)、在配置文件application.yml加上:

mybatis-plus: 
  mapper-locations: classpath:com/swnote/*/dao/*.xml
  type-aliases-package: com.swnote.auth.domain,com.swnote.blog.domain,com.swnote.common.domain

(3)、domain類上加上相應的注解:

/**
 * 站點相關配置信息
 * 
 * @author lzj
 * @since 1.0
 * @date [2019-04-04]
 */
@Data
@NoArgsConstructor
@TableName("comm_config")
public class Config implements Serializable {
    private static final long serialVersionUID = 2408416388054324323L;

    /**
     * 配置項key
     */
    @TableId(value = "configId", type = IdType.INPUT)
    private String configId;

    /**
     * 配置項value
     */
    @TableField("configValue")
    private String configValue;

    /**
     * 描述
     */
    @TableField("description")
    private String description;
}

其中@TableName、@TableId和@TableField都是mybatis-plus中定義的注解。

(4)、dao層代碼:

/**
 * 站點相關配置信息Dao
 * 
 * @author lzj
 * @since 1.0
 * @date [2019-04-04]
 */
@Repository
public interface ConfigDao extends BaseMapper<Config> {

}

(5)、service層代碼:

/**
 * 站點相關配置信息服務接口
 * 
 * @author lzj
 * @since 1.0
 * @date [2019-04-04]
 */
public interface IConfigService extends IService<Config> {

}
/**
 * 站點相關配置信息服務類
 * 
 * @author lzj
 * @since 1.0
 * @date [2019-04-04]
 */
@Service
public class ConfigService extends ServiceImpl<ConfigDao, Config> implements IConfigService {

}

通過上面dao層和service層代碼可以發現,對於增刪改查的操作都不需要寫任何代碼。

(6)、測試

@RunWith(SpringRunner.class)
@SpringBootTest
public class ConfigServiceTest {

    @Autowired
    private IConfigService configService;

    @Test
    public void save() throws Exception {
        Config config = new Config();
        config.setConfigId("test");
        config.setConfigValue("testValue");
        config.setDescription("測試內容");
        configService.save(config);
        
    }
    
    @Test
    public void update() {
        Config config = new Config();
        config.setConfigId("test");
        config.setConfigValue("testValue---g");
        config.setDescription("測試內容---g");
        configService.updateById(config);
    }
    
    @Test
    public void get() {
        Config config = configService.getById("test");
        System.out.println(config);
    }
    
    @After
    public void delete() {
        configService.removeById("test");
    }
}

經測試是沒有問題的,整合mybatis-plus可以明顯提高開發效率。

關注我

以你最方便的方式關注我:
微信公眾號:


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM