SpringBoot項目開發常用技術整合

Posted on by

1 創建一個springboot demo

請添加圖片描述

pom.xml添加springboot相關依賴。

1.1 創建Restful接口

springmvc構造並且返回一個json對象：

  • 在類上加@Controller註解
  • 在方法上加@ResponseBody

springboot構造並且返回一個json對象：

  • 在類上加@RestController註解（@RestController = @Controller + @ResponseBody）

 2 接口返回通用JSON對象

2.1 構建通用返回對象JSONResult

參考gitee代碼

public class JSONResult {
    private Integer status; // 響應狀態
    private String msg; // 響應消息
    private Object data; // 數據

    /*靜態工廠方法*/
    public static JSONResult build(Integer status, String msg, Object data) {
        return new JSONResult(status, msg, data);
    }

    public static JSONResult ok(Object data) {
        return new JSONResult(data);
    }
}

2.2 使用Jackson

使用Jackson對象pojo對象屬性進行處理，例如隱藏、格式化輸出、默認值。

public class User {

    private String name;

    @JsonIgnore
    private String password;
    private Integer age;
    @JsonFormat(pattern = "yyyy-MM-dd hh:mm:ss", locale = "zh", timezone = "GMT+8")
    private Date birthday;

    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String desc;
}

3 SpringBoot開發環境熱部署

devtools可以實現頁面熱部署（即頁面修改後會立即生效，可以直接在application.properties文件中配置spring.thymeleaf.cache=false來實現），實現類文件熱部署（類文件修改後不會立即生效），實現對屬性文件的熱部署。
即devtools會監聽classpath下的文件變動，並且會立即重啟應用（發生在保存時機），註意：因為其采用的虛擬機機制，該項重啟是很快的 。

（1）base classloader （Base類加載器）：加載不改變的Class，例如：第三方提供的jar包。
（2）restart classloader（Restart類加載器）：加載正在開發的Class。
為什麼重啟很快，因為重啟的時候隻是加載瞭在開發的Class，沒有重新加載第三方的jar包。

默認情況下，/META-INF/maven，/META-INF/resources，/resources，/static，/templates，/public這些文件夾下的文件修改不會使應用重啟，但是會重新加載（devtools內嵌瞭一個LiveReload server，當資源發生改變時，瀏覽器刷新）。

依賴

<!--熱部署-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-devtools</artifactId>
    <!-- optional=true, 依賴不會傳遞, 該項目依賴devtools;
        之後依賴boot項目的項目如果想要使用devtools, 需要重新引入 -->
    <optional>true</optional>
</dependency>

配置

#熱部署生效
spring.devtools.restart.enabled=true
#設置重啟的目錄
spring.devtools.restart.additional-paths=src/main/java
#classpath目錄下的WEB-INF文件夾內容修改不重啟
spring.devtools.restart.exclude=WEB-INF/**
#spring.devtools.restart.exclude=static/**,public/**

如果IDEA devtools熱部署沒有生效，進行以下操作。

  1. 開啟自動編譯：Files——Settings——Build,Execution,Deployment——Compiler
  2. 使用shift+ctrl+alt+/，選擇Registry。

請添加圖片描述

4 資源文件屬性配置

 4.1 資源文件中的屬性配置與映射到實體類

// com.lzp.opensource.name=lzp

@Configuration
@1(prefix = "com.lzp.opensource")
@PropertySource(value = "classpath:resource.properties")
public class Resource {
    private String name;
    private String website;
    private String language;
}

4.2 Server和Tomcat配置（詳細配置參考Gitee）

server.port=8088
server.tomcat.uri-encoding=UTF-8

5 SpringBoot整合模板引擎

 5.1 集成freemarker

添加依賴、配置，準備好前端頁面放到配置dir目錄下。測試代碼：

/**
 * 測試向頁面註入屬性
 *
 * @param modelMap
 * @return
 */
@RequestMapping("/index")
public String index(ModelMap modelMap) {
    modelMap.addAttribute("resource", resource);
    return "freemarker/index";
}

/**
 * 測試多層路徑，不需要加後綴
 *
 * @return
 */
@RequestMapping("/center")
public String center() {
    return "freemarker/center/center";
}

5.2 集成thymeleaf

############################################################
# thymeleaf 靜態資源配置
############################################################
spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html
spring.thymeleaf.mode=HTML5
spring.thymeleaf.encoding=UTF-8
spring.thymeleaf.content-type=text/html
# 關閉緩存, 即時刷新, 上線生產環境需要改為true
spring.thymeleaf.cache=false

## 設置靜態文件目錄，js、css等
spring.mvc.static-path-pattern=/static/**

內容包含：

  • 對象屬性獲取與頁面屬性設置 th:id
  • html內容替換 th:text/utext
  • 根元素設置 th:object
  • 超鏈接 th:href
  • form th:action=”@{/th/postform}”
  • 語法：比較、循環遍歷、switch

5.2.1 集成i18n屬性配置

i18n對程序來說，在不修改內部代碼的情況下，能根據不同語言及地區顯示相應的界面。

############################################################# i18n 資源配置############################################################spring.messages.basename=i18n/messages# 緩存時間 單位 sspring.messages.cache-duration=1spring.messages.encoding=UTF-8

指定目錄下配置屬性

roles.manager=managerroles.superadmin=lzp

6 全局捕獲異常

頁面跳轉形式：接口直接返回一個頁面ModelAndView。

ajax形式：返回統一響應對象，前端解析對象獲取數據。

統一返回異常的形式

@ControllerAdvicepublic class ExceptionErrorHandler {    /**     * 異常跳轉頁面     */    public static final String ERROR_VIEW = "error";    @ExceptionHandler(value = Exception.class)    public Object errorHandler(HttpServletRequest request,                               HttpServletResponse response,                               Exception e) throws Exception {        // 後臺打印日志        e.printStackTrace();        if (isAjax(request)) {            // 返回ajax響應            return JSONResult.errorException(e.getMessage());        } else {            // 返回頁面            ModelAndView mav = new ModelAndView();            mav.addObject("exception", e);            mav.addObject("url", request.getRequestURL());            // 把錯誤頁面返回給前端，而不是使用springboot自帶的頁面            mav.setViewName(ERROR_VIEW);            return mav;        }    }    /**     * 判斷請求是否是ajax請求     *     * @param httpRequest     * @return     */    public static boolean isAjax(HttpServletRequest httpRequest) {        return (httpRequest.getHeader("X-Requested-With") != null                && "XMLHttpRequest"                .equals(httpRequest.getHeader("X-Requested-With").toString()));    }}

7 集成mybatis以及分頁

7.1 mybatis-generator的使用

  1. 添加mybatis、mysql、數據源、tkmybatis、pagehelper依賴。如果用hikari，默認支持不需要引用依賴。
  2. 添加application.properties相關配置。
  3. 配置generatorConfig.xml pojo、mapper、xml、表等
  4. 使用GeneratorDisplay生成文件。

Application添加mapper掃描配置

//掃描 mybatis mapper 包路徑@MapperScan(basePackages = "com.lzp.mapper")// 掃描指定位置@ComponentScan({"com.lzp", "org.n3r.idworker"})@SpringBootApplicationpublic class Application {    public static void main(String[] args) {        SpringApplication.run(Application.class, args);    }}

7.2 tkmybatis的一些用法

使用通用Mapper可以節省很多代碼

public interface MyMapper<T> extends Mapper<T>, MySqlMapper<T> {}public interface SysUserMapper extends MyMapper<SysUser> {}

調用

userMapper.insert(user);userMapper.updateByPrimaryKeySelective(user);@Overridepublic List<SysUser> queryUserList(SysUser user) {    // 條件    Example example = new Example(SysUser.class);    Example.Criteria criteria = example.createCriteria();    criteria.andLike("username", "%" + user.getUsername() + "%");    return userMapper.selectByExample(example);}

8 聲明式事務支持

@Transactional(propagation = Propagation.REQUIRED)@Overridepublic void saveUserTransactional(SysUser user) {    userMapper.insert(user);    int i = 1 / 0;    user.setIsDelete(1);    userMapper.updateByPrimaryKeySelective(user);}

REQUIRED 如果沒有事務，則創建事務；已有則加入到當前事務。

SUPPORTS 如果已有事務，加入當前事務；沒有也可以。

9 集成Redis

添加pom和application.properties配置

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

使用StringRedisTemplete操作數據。

10 集成定時功能

// 啟動定時操作
@EnableScheduling
public class Application {...}

調度類

@Component
public class SchedulerJob {

    @Scheduled(fixedRate = 3000)
    public void printLog() {
        System.out.println("每隔3秒");
    }

    @Scheduled(cron = "0/1 * * * * ?")
    public void printLogInterval() {
        System.out.println("每隔1秒");
    }
}

11 異步任務

Spring Boot異步執行使用場景

  • 發送短信、發送郵件
  • App消息推送
  • 節省運維淩晨發佈任務時間提供效率
//開啟異步調用方法
@EnableAsync
public class Application {

結合

@Component
public class AsyncTask {

    @Async
    public Future<Boolean> doTask11() throws Exception {
        long start = System.currentTimeMillis();
        Thread.sleep(1000);
        long end = System.currentTimeMillis();
        System.out.println("任務1耗時:" + (end - start) + "毫秒");
        return new AsyncResult<>(true);
    }
}

12 配置攔截器

攔截器，訪問某個請求前後進行攔截。

註冊配置

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Bean
    public UserTokenInterceptor userTokenInterceptor() {
        return new UserTokenInterceptor();
    }

    /**
     * 註冊攔截器
     *
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(userTokenInterceptor())
                .addPathPatterns("/testIntercept")
                .addPathPatterns("/hello")
                .addPathPatterns("/shopcart/add")
    }
}

UserTokenInterceptor參考詳細代碼。

代碼地址

源碼地址：https://gitee.com/dtyytop/initialdemo

到此這篇關於SpringBoot項目開發常用技術整合的文章就介紹到這瞭,更多相關SpringBoot開發內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：