Spring Boot2篇 - 十二、Spring Boot 异步、定时、邮件任务

Dear 丶 2023-10-03 08:52 4阅读 0赞

## 十二、Spring Boot 异步、定时、邮件任务 ##

> 在工作中，常常会用到异步处理任务，比如我们在网站上发送邮件，后台会去发送邮件，此时前台会造成响应不动，直到邮件发送完毕，响应才会成功，所以我们一般会采用多线程的方式去处理这些任务。还有一些定时任务，比如需要在每天凌晨的时候，分析一次前一天的日志信息。还有就是邮件的发送，微信的前身也是邮件服务,这些东西的实现其实是SpringBoot给我们提供了对应的支持，我们上手使用十分的简单，只需要开启一些注解支持，配置一些配置文件即可

### 12.1 异步任务 ###

*  在Service包中创建AsyncService

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

/**
     * @author cVzhanshi
     * @create 2021-06-21 17:05
     */
    @Service
    public class AsyncService {
        
        public void hello(){
        
            try {
        
                //假装正在处理数据，使用线程设置一些延时，模拟同步等待的情况
                Thread.sleep(3000);
            } catch (InterruptedException e) {
        
                e.printStackTrace();
            }
            System.out.println("业务进行中....");
        }
    }

*  在Controller包中创建AsyncService

/**
     * @author cVzhanshi
     * @create 2021-06-21 17:06
     */
    @RestController
    public class AsyncController {
        
    
        @Autowired
        AsyncService asyncService;
    
        @RequestMapping("/hello")
        public String hello(){
        
            asyncService.hello();
            return "OK";
        }
    }

*  访问http://localhost:8080/hello进行测试，3秒后出现ok，这是同步等待的情况

> 问题：我们如果想让用户直接得到消息，就在后台使用多线程的方式进行处理即可，但是每次都需要自己手动去编写多线程的实现的话，太麻烦了，我们只需要用一个简单的办法，在我们的方法上加一个简单的注解即可

*  给hello方法加上@Async注解

//告诉Spring这是一个异步方法
    @Async
    public void hello(){
        
       try {
        
           Thread.sleep(3000);
      } catch (InterruptedException e) {
        
           e.printStackTrace();
      }
       System.out.println("业务进行中....");
    }

*  SpringBoot就会自己开一个线程池，进行调用！但是要让这个注解生效，我们还需要在主程序上添加一个注解@EnableAsync ，开启异步注解功能

@EnableAsync//开启异步注解功能
    @SpringBootApplication
    public class Springboot09TestApplication {
        
    
        public static void main(String[] args) {
        
            SpringApplication.run(Springboot09TestApplication.class, args);
        }
    
    }

*  重启测试，网页瞬间响应，后台代码依旧执行

### 12.2 定时任务 ###

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

**Cron表达式**：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NDA4Mzkw_size_16_color_FFFFFF_t_70]![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NDA4Mzkw_size_16_color_FFFFFF_t_70 1]

*  创建一个ScheduledService，定义hello时间并通过cron表达式定时运行

/**
     * @author cVzhanshi
     * @create 2021-06-21 22:16
     */
    public class ScheduledService {
        
        //秒   分   时     日   月   周几
        //0 * * * * MON-FRI
        //注意cron表达式的用法；
        @Scheduled(cron = "0 * * * * 0-7")
        public void hello(){
        
            System.out.println("hello.....");
        }
    }

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

@EnableAsync
    @EnableScheduling
    @SpringBootApplication
    public class Springboot09TestApplication {
        
    
        public static void main(String[] args) {
        
            SpringApplication.run(Springboot09TestApplication.class, args);
        }
    
    }

*  常用的cron表达式

（1）0/2 * * * * ?   表示每2秒 执行任务
    （1）0 0/2 * * * ?   表示每2分钟 执行任务
    （1）0 0 2 1 * ?   表示在每月的1日的凌晨2点调整任务
    （2）0 15 10 ? * MON-FRI   表示周一到周五每天上午10:15执行作业
    （3）0 15 10 ? 6L 2002-2006   表示2002-2006年的每个月的最后一个星期五上午10:15执行作
    （4）0 0 10,14,16 * * ?   每天上午10点，下午2点，4点
    （5）0 0/30 9-17 * * ?   朝九晚五工作时间内每半小时
    （6）0 0 12 ? * WED   表示每个星期三中午12点
    （7）0 0 12 * * ?   每天中午12点触发
    （8）0 15 10 ? * *   每天上午10:15触发
    （9）0 15 10 * * ?     每天上午10:15触发
    （10）0 15 10 * * ?   每天上午10:15触发
    （11）0 15 10 * * ? 2005   2005年的每天上午10:15触发
    （12）0 * 14 * * ?     在每天下午2点到下午2:59期间的每1分钟触发
    （13）0 0/5 14 * * ?   在每天下午2点到下午2:55期间的每5分钟触发
    （14）0 0/5 14,18 * * ?     在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
    （15）0 0-5 14 * * ?   在每天下午2点到下午2:05期间的每1分钟触发
    （16）0 10,44 14 ? 3 WED   每年三月的星期三的下午2:10和2:44触发
    （17）0 15 10 ? * MON-FRI   周一至周五的上午10:15触发
    （18）0 15 10 15 * ?   每月15日上午10:15触发
    （19）0 15 10 L * ?   每月最后一日的上午10:15触发
    （20）0 15 10 ? * 6L   每月的最后一个星期五上午10:15触发
    （21）0 15 10 ? * 6L 2002-2005   2002年至2005年的每月的最后一个星期五上午10:15触发
    （22）0 15 10 ? * 6#3   每月的第三个星期五上午10:15触发

### 12.3 邮件任务 ###

> 邮件发送，在我们的日常开发中，也非常的多，Springboot也帮我们做了支持

*  邮件发送需要引入spring-boot-start-mail
 *  SpringBoot 自动配置MailSenderAutoConfiguration
 *  定义MailProperties内容，配置在application.yaml中
 *  自动装配JavaMailSender
 *  测试邮件发送

**测试：**

*  引入pom依赖

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

看它引入的依赖，可以看到 jakarta.mail

<dependency>
       <groupId>com.sun.mail</groupId>
       <artifactId>jakarta.mail</artifactId>
       <version>1.6.4</version>
       <scope>compile</scope>
    </dependency>

*  查看 MailSenderAutoConfiguration源码

@Import({
         MailSenderJndiConfiguration.class, MailSenderPropertiesConfiguration.class })
    public class MailSenderAutoConfiguration {
        
    }

> 引入了MailSenderJndiConfiguration，继续深入查看MailSenderJndiConfiguration

*  查看MailSenderJndiConfiguration源码

@Configuration(proxyBeanMethods = false)
    @ConditionalOnClass(Session.class)
    @ConditionalOnProperty(prefix = "spring.mail", name = "jndi-name")
    @ConditionalOnJndi
    class MailSenderJndiConfiguration {
        
    
        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;
        }
    
        @Bean
        @ConditionalOnMissingBean
        Session session() {
        
            String jndiName = this.properties.getJndiName();
            try {
        
                return JndiLocatorDelegate.createDefaultResourceRefLocator().lookup(jndiName, Session.class);
            }
            catch (NamingException ex) {
        
                throw new IllegalStateException(String.format("Unable to find Session in JNDI location %s", jndiName), ex);
            }
        }
    
    }

> 该类把 JavaMailSenderImpl 交给了Spring管理

*  继续查看配置类MailProperties源码

@ConfigurationProperties(prefix = "spring.mail")
    public class MailProperties {
        
    	private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
    	private String host;
    	private Integer port;
    	private String username;
    	private String password;
    	private String protocol = "smtp";
    	private Charset defaultEncoding = DEFAULT_CHARSET;
    	private Map<String, String> properties = new HashMap<>();
    	private String jndiName;
    	...}

*  然后通过查看配置类，我们修改配置文件application.properties

spring.mail.username=cvzhanshi@qq.com
    spring.mail.password=usdtkujdffeehdc
    spring.mail.host=smtp.qq.com
    #开启加密
    spring.mail.properties.mail.smtp.ssl.enable=true

> password的获取方式查看：[获取passwod][passwod]

*  测试

@SpringBootTest
    class Springboot09TestApplicationTests {
        
    
        @Autowired
        JavaMailSender mailSender;
    
    
        @Test
        void contextLoads() {
        
            //一个简单的邮件
            SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
            simpleMailMessage.setSubject("cv战士好帅");
            simpleMailMessage.setText("小胖考研必上岸，李18k薪资");
            simpleMailMessage.setFrom("cvzhanshi@qq.com");
            simpleMailMessage.setTo("16132146@qq.com","31008532@qq.com");
            mailSender.send(simpleMailMessage);
        }
    
    
        @Test
        void contextLoads1() throws MessagingException {
        
            //一个复杂的邮件
            MimeMessage mimeMessage = mailSender.createMimeMessage();
            //组装
            MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
            helper.setSubject("cvzhanshi 最帅");
            helper.setText("<h1>胖考研必上岸，李18k薪资</h1>",true);
    
            //附件
            helper.addAttachment("1.jpg",new File("F:\\desktop\\1.jpg"));
    
            helper.setFrom("cvzhanshi@qq.com");
            helper.setTo(new String[]{
        "161313146@qq.com","31208532@qq.com","cvzhanshi@qq.com"});
    
            mailSender.send(mimeMessage);
    
        }
    
    }

> 查看邮件，测试成功
> 
> 只需要使用Thymeleaf进行前后端结合即可开发自己网站邮件收发功能了

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NDA4Mzkw_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20210622105733998.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NDA4Mzkw,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NDA4Mzkw_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20210622105752604.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NDA4Mzkw,size_16,color_FFFFFF,t_70
[passwod]: https://blog.csdn.net/qq_45408390/article/details/115589812