Spring Boot学习之任务学习【异步、定时、邮件】

Love The Way You Lie 2024-03-27 09:50 217阅读 0赞

#### 文章目录 ####

*  一 异步任务
 *   *  1.1 创建spring Boot项目，选择Spring Web
     *  1.2 创建AsyncService类
     *  1.3 编写controller类
     *  1.4 在启动类上开启异步功能
     *  1.5 测试结果
 *  二 定时任务
 *   *  2.1 基础知识
     *  2.2 项目创建
     *  2.3 创建一个ScheduledService
     *  2.4 在主程序上增加@EnableScheduling 开启定时任务功能
     *  2.5 测试结果
 *  三 邮件任务
 *   *  3.1 项目创建
     *  3.2 源码探究
     *  3.3 编辑springboot配置文件
     *  3.4 测试

## 一 异步任务 ##

*  异步处理是非常常用的
    
     *  比如我们在网站上发送邮件，后台会去发送邮件，此时前台会造成响应不动，直到邮件发送完毕，响应才会成功，所以我们一般会采用多线程的方式去处理这些任务。

### 1.1 创建spring Boot项目，选择Spring Web ###

![在这里插入图片描述][c4dbccc4f1f645d0b6e41a22ece08401.png]

*  spring3.0.2不支持jdk1.8，记得选择2.7.8或者更低的版本  
    ![在这里插入图片描述][8506712860774c07ae86f0bcc478cd34.png]
 *  同时注意项目结构和pom中java版本是否正确  
    ![在这里插入图片描述][ad8032f29239487da66f7f0354f84346.png]

### 1.2 创建AsyncService类 ###

*  编写方法，假装正在处理数据，使用线程设置一些延时，模拟同步等待的情况  
    ![在这里插入图片描述][bb5f54995f744beb9c9cebfbbb8da422.png]
 *  使用@Async注解，SpringBoot就会自己开一个线程池，进行调用。
    
        import org.springframework.scheduling.annotation.Async;
        import org.springframework.stereotype.Service;
        
        /**
         * @author 缘友一世
         * date 2023/1/28-20:07
         */
        @Service
        public class AsyncService {
              
            @Async //告诉Spring这是一个异步方法
            public void hello() {
              
                try {
              
                    Thread.sleep(3000);
                } catch (InterruptedException e) {
              
                    throw new RuntimeException(e);
                }
                System.out.println("数据处理中···");
            }
        }

### 1.3 编写controller类 ###

import com.yang.service.AsyncService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /**
     * @author 缘友一世
     * date 2023/1/28-20:09
     */
    @RestController
    public class AsyncController {
        
        @Autowired
        AsyncService asyncService;
    
        @RequestMapping("/hello")
        public String hello() {
        
            asyncService.hello();
            return "ok";
        }
    }

### 1.4 在启动类上开启异步功能 ###

*  加注解@EnableAsync ，开启异步注解功能；
    
        import org.springframework.boot.SpringApplication;
        import org.springframework.boot.autoconfigure.SpringBootApplication;
        import org.springframework.scheduling.annotation.EnableAsync;
        
        @SpringBootApplication
        @EnableAsync //开启异步注解功能
        public class SpringTaskApplication {
              
        
            public static void main(String[] args) {
              
                SpringApplication.run(SpringTaskApplication.class, args);
            }
        
        }

### 1.5 测试结果 ###

![在这里插入图片描述][c2f9ce4b93424034a66152f8cc7746d6.gif_pic_center]

## 二 定时任务 ##

### 2.1 基础知识 ###

*  项目开发中经常需要执行一些定时任务，比如需要在每天凌晨的时候，分析一次前一天的日志信息，Spring为我们提供了异步执行任务调度的方式，提供了两个接口
    
     *  TaskScheduler 任务调度者
     *  TaskExecutor 任务执行者
 *  两个注解
    
     *  @EnableScheduling 开启定时功能的注解
     *  @Scheduled 表示执行的时机

--------------------

*  cron
    
     *  计划任务，是任务在约定的时间执行已经计划好的工作。
     *  在Linux中，我们经常用到 cron 服务器来完成这项工作。
     *  cron服务器可以根据配置文件约定的时间来执行特定的任务。
     *  [cron百度百科][cron]
     *  [cron在线生成器][cron 1]

<table> 
 <thead> 
  <tr> 
   <th>字段</th> 
   <th>允许值</th> 
   <th>允许的特殊字符</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>秒</td> 
   <td>0~59</td> 
   <td>，- * /</td> 
  </tr> 
  <tr> 
   <td>分</td> 
   <td>0~59</td> 
   <td>，- * /</td> 
  </tr> 
  <tr> 
   <td>时</td> 
   <td>0~23</td> 
   <td>，- * /</td> 
  </tr> 
  <tr> 
   <td>日期</td> 
   <td>1~31</td> 
   <td>，- * ？ /L W C</td> 
  </tr> 
  <tr> 
   <td>月</td> 
   <td>1~12</td> 
   <td>，- * /</td> 
  </tr> 
  <tr> 
   <td>星期</td> 
   <td>0~7或SUN-SAT</td> 
   <td>，- * ？ / L C #</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th>字符</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>，</td> 
   <td>枚举</td> 
  </tr> 
  <tr> 
   <td>-</td> 
   <td>区间</td> 
  </tr> 
  <tr> 
   <td>*</td> 
   <td>任意</td> 
  </tr> 
  <tr> 
   <td>/</td> 
   <td>步长</td> 
  </tr> 
  <tr> 
   <td>？</td> 
   <td>日/星期冲突匹配</td> 
  </tr> 
  <tr> 
   <td>L</td> 
   <td>最后</td> 
  </tr> 
  <tr> 
   <td>W</td> 
   <td>工作日</td> 
  </tr> 
  <tr> 
   <td>C</td> 
   <td>和calendar联系后计算过的值</td> 
  </tr> 
  <tr> 
   <td>#</td> 
   <td>星期，4#2——第二个星期三</td> 
  </tr> 
 </tbody> 
</table>

### 2.2 项目创建 ###

*  同异步任务创建项目步骤

### 2.3 创建一个ScheduledService ###

```java
    import org.springframework.scheduling.annotation.Scheduled;
    import org.springframework.stereotype.Service;
    
    /**
     * @author 缘友一世
     * date 2023/1/29-9:41
     */
    @Service
    
    public class ScheduledService {
        //秒 分 时 日 月 周几
        //0 * * * * MON-FRI
        //cron表达式
        @Scheduled(cron="0 50 9 * * ?")
        public void hello() {
            System.out.println("hello");
        }
    }
    
    ```

### 2.4 在主程序上增加@EnableScheduling 开启定时任务功能 ###

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.scheduling.annotation.EnableScheduling;
    
    @SpringBootApplication
    @EnableScheduling //开启定时功能
    public class SpringTimedTaskApplication {
        
        public static void main(String[] args) {
        
            SpringApplication.run(SpringTimedTaskApplication.class, args);
        }
    }

### 2.5 测试结果 ###

![在这里插入图片描述][d13d46ccb48d4b88b5780c9752759eef.png]

## 三 邮件任务 ##

### 3.1 项目创建 ###

*  同异步任务项目创建，请参看前面的内容

1.  邮件发送需要引入spring-boot-start-mail
    
        
        <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-mail</artifactId>
         </dependency>

### 3.2 源码探究 ###

1.  ctrl+鼠标左键，点击`<artifactId>spring-boot-starter-mail</artifactId>`进入到其pom文件，可以发现其依赖中存在
    
        <dependency>
              <groupId>com.sun.mail</groupId>
              <artifactId>jakarta.mail</artifactId>
              <version>1.6.7</version>
              <scope>compile</scope>
            </dependency>
2.  查看自动配置类：MailSenderAutoConfiguration
    
     *  方法一：双击shift在搜索框中输入`MailSenderAutoConfiguration`，进行搜索
     *  方法二：在外部库中手动查找  
        ![在这里插入图片描述][e21087b36c74468b97936ca92871fea0.png]  
        ![在这里插入图片描述][cf7d2446ea2a45abb1527c2c6571c1f4.png]
     *  进入`MailSenderAutoConfiguration`中，发现这个类中并没有注册`@Bean` ![在这里插入图片描述][efc389cb8e824a0dae54a075d1bcbbfa.png]
     *  最终查看导入的类中`MailSenderJndiConfiguration.class`发现了`@Bean`
    
        private final MailProperties properties;
        MailSenderJndiConfiguration(MailProperties properties) {
              
            this.properties = properties;
        }
        @Bean
            JavaMailSenderImpl mailSender(Session session) {
              
                JavaMailSenderImpl sender = new JavaMailSenderImpl();
                sender.setDefaultEncoding(this.properties.getDefaultEncoding().name());
                sender.setSession(session);
                return sender;
            }
    
     *  然后点进`MailProperties`查看配置文件
    
        @ConfigurationProperties(
            prefix = "spring.mail"
        )
        public class MailProperties {
              
            private static final Charset DEFAULT_CHARSET;
            private String host;
            private Integer port;
            private String username;
            private String password;
            private String protocol = "smtp";
            private Charset defaultEncoding;
            private Map<String, String> properties;
            private String jndiName;
    
     *  到此可以找到配置文件需要配置的信息

### 3.3 编辑springboot配置文件 ###

1.  获取授权码【这里以QQ邮箱为例】
    
     *  登录QQ邮箱  
        ![在这里插入图片描述][af8753374b08437da08564035682f8e7.png]
     *  下滑找到如下内容，点击开启POP/SMTP服务  
        ![在这里插入图片描述][23b50abda36946b49db25ab2508c3319.png]
     *  按照要求进行操作  
        ![在这里插入图片描述][f1122ee3b27f439b806878741d8c32d9.png]
     *  获取到授权码，将其复制  
        ![在这里插入图片描述][8fe1cccb2f1840adb9a1278ba48dc74b.png]
2.  配置springboot文件
    
        spring.mail.username=2330648064@qq.com
        spring.mail.password= xxxxxxxxx#(授权码)
        spring.mail.host=smtp.qq.com
        #开启加密验证
        spring.mail.properties.mail.smtp.enable=true

### 3.4 测试 ###

1.  编写测试代码
    
        import org.junit.jupiter.api.Test;
        import org.springframework.beans.factory.annotation.Autowired;
        import org.springframework.boot.test.context.SpringBootTest;
        import org.springframework.mail.SimpleMailMessage;
        import org.springframework.mail.javamail.JavaMailSenderImpl;
        import org.springframework.mail.javamail.MimeMessageHelper;
        
        import javax.mail.MessagingException;
        import javax.mail.internet.MimeMessage;
        import java.io.File;
        
        @SpringBootTest
        class SpringTaskApplicationTests {
              
            @Autowired
            JavaMailSenderImpl mailSender;
            //简单邮件
            @Test
            void contextLoads() {
              
                SimpleMailMessage mailMessage = new SimpleMailMessage();
                mailMessage.setSubject("hello");//标题
                mailMessage.setText("thank you");
        
                mailMessage.setTo("2330648064@qq.com");
                mailMessage.setFrom("2330648064@qq.com");
        
                mailSender.send(mailMessage);
            }
            //复杂邮件
            @Test
            void contextLoads2() throws MessagingException {
              
                MimeMessage mimeMessage = mailSender.createMimeMessage();
                //组装
                MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
                //正文
                helper.setSubject("hello2");
                helper.setText("<h1 style='color:red'>thank you2</h1>",true);
                //附件
                //使用内容根路径成功！
                helper.addAttachment("01.jpg",new File("src/main/resources/static/test01.jpg"));
        
                helper.setTo("2330648064@qq.com");
                helper.setFrom("2330648064@qq.com");
        
                mailSender.send(mimeMessage);
            }
        }
2.  测试结果  
    ![在这里插入图片描述][7aa54695279b4931982f6ba7a99fd39e.png]  
    ![在这里插入图片描述][5b07535d12ec4705a06ff1f523c84df2.png]

[c4dbccc4f1f645d0b6e41a22ece08401.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/4cb1f86042b543cc8b0c19db0cebac1d.png
[8506712860774c07ae86f0bcc478cd34.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/a5eb3c427b9a4dafa1173d264df7bea7.png
[ad8032f29239487da66f7f0354f84346.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/823ce4ab16194363b249fe3c7e573e3c.png
[bb5f54995f744beb9c9cebfbbb8da422.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/f3ff567050b8414aa48bc8a32d65c266.png
[c2f9ce4b93424034a66152f8cc7746d6.gif_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/4bf717732a534cdba21f969f1bb2d782.png
[cron]: https://baike.baidu.com/item/cron/10952601
[cron 1]: http://cron.ciding.cc/
[d13d46ccb48d4b88b5780c9752759eef.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/836da6bff3c44a78a44bc386b1e08b7b.png
[e21087b36c74468b97936ca92871fea0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/8dce9aac19624186ad3e8778b333ef6f.png
[cf7d2446ea2a45abb1527c2c6571c1f4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/621927cb4bc74ee781e8bf54e7a10ac6.png
[efc389cb8e824a0dae54a075d1bcbbfa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/e64e9be3ae8c46cf90824543c763afd1.png
[af8753374b08437da08564035682f8e7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/204720870a78423daddd30f12e2564e9.png
[23b50abda36946b49db25ab2508c3319.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/7cf6c44944d149fb85c1b71f74ce8d47.png
[f1122ee3b27f439b806878741d8c32d9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/a313d803ab5a423daaa0e89c09bfa1df.png
[8fe1cccb2f1840adb9a1278ba48dc74b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/dda727add4654392b6cc90615de61976.png
[7aa54695279b4931982f6ba7a99fd39e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/69b7b81d59e6499fa14169adc8b5fd61.png
[5b07535d12ec4705a06ff1f523c84df2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/930b46279a0b4cdfaa03efd52f1693b3.png