[Java知识库] SpringBoot开发常用技术整合

开发: C++知识库 Java知识库 JavaScript Python PHP知识库人工智能区块链大数据移动开发嵌入式开发工具数据结构与算法开发测试游戏开发网络协议系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑笔记本显卡显示器固态硬盘硬盘耳机手机 iphone vivo oppo 小米华为单反装机图拉丁

-> Java知识库 -> SpringBoot开发常用技术整合 -> 正文阅读

[Java知识库]SpringBoot开发常用技术整合

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热部署没有生效，进行以下操作。

开启自动编译：Files——Settings——Build,Execution,Deployment——Compiler
使用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的使用

添加mybatis、mysql、数据源、tkmybatis、pagehelper依赖。如果用hikari，默认支持不需要引用依赖。
添加application.properties相关配置。
配置generatorConfig.xml pojo、mapper、xml、表等
使用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参考详细代码。