事务

事务的理解

事务是访问数据库的一个操作序列,数据库应用系统通过事务集来完成对数据库的存取。事务的正确执行使得数据库从一种状态转换成另一种状态。
事务必须服从ISO/IEC所制定的ACID原则。ACID是原子性(atomicity)、一致性(consistency)、隔离性(isolation)和持久性(durability)的缩写事务必须服从ISO/IEC所制定的ACID原则。ACID是原子性(atomicity)、一致性(consistency)、隔离性(isolation)和持久性(durability)的缩写。

  1. 原子性。即不可分割性,事务要么全部被执行,要么就全部不被执行。如果事务的所有子事务全部提交成功,则所有的数据库操作被提交,数据库状态发生转换;如果有子事务失败,则其他子事务的数据库操作被回滚,即数据库回到事务执行前的状态,不会发生状态转换。
  2. 一致性。事务的执行使得数据库从一种正确状态转换成另一种正确状态。
  3. 隔离性。在事务正确提交之前,不允许把该事务对数据的任何改变提供给任何其他事务,即在事务正确提交之前,它可能的结果不应显示给任何其他事务。
  4. 持久性。事务正确提交后,其结果将永久保存在数据库中,即使在事务提交后有了其他故障,事务的处理结果也会得到保存。

    事务的使用

    Spring采用注解的方式控制事务,一般在service层面上进行事务的控制,控制事务的注解为@Transactional
    即在service层中需要控制事务的类(不是接口类,而是实现类)或者方法(要求是public方法)上添加注解@Transactional,系统设计要求尽量放在需要进行事务管理的方法上,而不是放在所有接口实现类上。
    只针对写操作,读操作就没必要了
    示例代码:

    1. /**
    2. * 事务控制在service层面
    3. * 加上注解:@Transactional,声明的方法就是一个独立的事务(有异常DB操作全部回滚)
    4. */
    5. @Transactional
    6. public void testTran() {
    7. JeecgDemo pp = new JeecgDemo();
    8. pp.setAge(1111);
    9. pp.setName("测试事务 小白兔 1");
    10. jeecgDemoMapper.insert(pp);
    11. JeecgDemo pp2 = new JeecgDemo();
    12. pp2.setAge(2222);
    13. pp2.setName("测试事务 小白兔 2");
    14. jeecgDemoMapper.insert(pp2);
    15. Integer.parseInt("hello");//自定义异常
    16. JeecgDemo pp3 = new JeecgDemo();
    17. pp3.setAge(3333);
    18. pp3.setName("测试事务 小白兔 3");
    19. jeecgDemoMapper.insert(pp3);
    20. }

    错误的使用

  5. 接口中A、B两个方法,A无@Transactional标签,B有,上层通过A间接调用B,此时事务不生效。

  6. 接口中异常(运行时异常)被捕获而没有被抛出。默认配置下,spring 只有在抛出的异常为运行时 unchecked 异常时才回滚该事务,也就是抛出的异常为RuntimeException 的子类(Errors也会导致事务回滚),而抛出 checked 异常则不会导致事务回滚 。可通过 @Transactional rollbackFor进行配置。
  7. 多线程下事务管理因为线程不属于 spring 托管,故线程不能够默认使用 spring 的事务,也不能获取spring 注入的 bean 。在被 spring 声明式事务管理的方法内开启多线程,多线程内的方法不被事务控制。一个使用了@Transactional 的方法,如果方法内包含多线程的使用,方法内部出现异常,不会回滚线程中调用方法的事务。

    @Transactional注解


    @Transactional 实质是使用了 JDBC 的事务来进行事务控制的,基于 Spring 的动态代理的机制

  8. 事务开始时,通过AOP机制,生成一个代理connection对象,并将其放入 DataSource 实例的某个与 DataSourceTransactionManager 相关的某处容器中。在接下来的整个事务中,客户代码都应该使用该connection 连接数据库,执行所有数据库命令。[不使用该 connection 连接数据库执行的数据库命令,在本事务回滚的时候得不到回滚](物理连接 connection 逻辑上新建一个会话session;DataSource 与TransactionManager 配置相同的数据源)

  9. 事务结束时,回滚在第1步骤中得到的代理 connection 对象上执行的数据库命令,然后关闭该代理 connection 对象。(事务结束后,回滚操作不会对已执行完毕的SQL操作命令起作用)

@Transactional属性配置

事务、定时任务、系统接口通知、消息推送、短信接口、邮箱接口、消息敏感安全、自定义注解重复提交、批量插入效率建议、积木报表 - 图1
字段说明:

  1. value :主要用来指定不同的事务管理器;主要用来满足在同一个系统中,存在不同的事务管理器。比如在Spring中,声明了两种事务管理器txManager1, txManager2。然后,用户可以根据这个参数来根据需要指定特定的txManager.
  2. value 适用场景:在一个系统中,需要访问多个数据源或者多个数据库,则必然会配置多个事务管理器的
  3. REQUIRED_NEW:内部的事务独立运行,在各自的作用域中,可以独立的回滚或者提交;而外部的事务将不受内部事务的回滚状态影响。
  4. ESTED 的事务,基于单一的事务来管理,提供了多个保存点。这种多个保存点的机制允许内部事务的变更触发外部事务的回滚。而外部事务在混滚之后,仍能继续进行事务处理,即使部分操作已经被混滚。 由于这个设置基于 JDBC 的保存点,所以只能工作在 JDB C的机制。
  5. rollbackFor:让受检查异常回滚;即让本来不应该回滚的进行回滚操作。
  6. noRollbackFor:忽略非检查异常;即让本来应该回滚的不进行回滚操作。

多数据源的事务使用

  1. # 数据源
  2. spring:
  3. datasource:
  4. # master数据源配置
  5. mysql:
  6. driverClassName: com.mysql.jdbc.Driver
  7. url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8
  8. username: root
  9. password: root
  10. # cluster数据源配置
  11. oracle:
  12. driver-class-name: oracle.jdbc.driver.OracleDriver
  13. url: jdbc:oracle:thin:@localhost:1521:orcl
  14. username: root
  15. password: root

根据不同的数据库创建对应的事务管理器

  1. @Bean(name = "mysqlTransactionManager")
  2. @Bean(name = "oracleTransactionManager")
  1. @Configuration
  2. @MapperScan(basePackages = "com.spring.boot.mapper.mysql",sqlSessionTemplateRef = ",mysqlSqlSessionTemplate")
  3. public class ClusterDataSourceConfig {
  4. /**
  5. * 创建数据源
  6. *@return DataSource
  7. */
  8. @Bean(name = "mysqlDataSource")
  9. @ConfigurationProperties(prefix = "spring.datasource.mysql")
  10. public DataSource masterDataSource() {
  11. return DataSourceBuilder.create().build();
  12. }
  13. /**
  14. * 创建工厂
  15. *@param dataSource
  16. *@throws Exception
  17. *@return SqlSessionFactory
  18. */
  19. @Bean(name = "mysqlSqlSessionFactory")
  20. public SqlSessionFactory masterSqlSessionFactory(@Qualifier("mysqlDataSource") DataSource dataSource) throws Exception {
  21. SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
  22. bean.setDataSource(dataSource);
  23. bean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/mysql/*.xml"));
  24. return bean.getObject();
  25. }
  26. /**
  27. * 创建事务
  28. *@param dataSource
  29. *@return DataSourceTransactionManager
  30. */
  31. @Bean(name = "mysqlTransactionManager")
  32. public DataSourceTransactionManager masterDataSourceTransactionManager(@Qualifier("mysqlDataSource") DataSource dataSource) {
  33. return new DataSourceTransactionManager(dataSource);
  34. }
  35. /**
  36. * 创建模板
  37. *@param sqlSessionFactory
  38. *@return SqlSessionTemplate
  39. */
  40. @Bean(name = "clusterSqlSessionTemplate")
  41. public SqlSessionTemplate masterSqlSessionTemplate(@Qualifier("clusterSqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
  42. return new SqlSessionTemplate(sqlSessionFactory);
  43. }
  44. }
  1. @Configuration
  2. @MapperScan(basePackages = "com.spring.boot.mapper.oracle",sqlSessionTemplateRef = "oracleSessionTemplate")
  3. public class MasterDataSourceConfig {
  4. /**
  5. * 创建数据源
  6. *@return DataSource
  7. */
  8. @Bean(name = "oracleDataSource")
  9. @ConfigurationProperties(prefix = "spring.datasource.oracle")
  10. @Primary
  11. public DataSource masterDataSource() {
  12. return DataSourceBuilder.create().build();
  13. }
  14. /**
  15. * 创建工厂
  16. *@param dataSource
  17. *@throws Exception
  18. *@return SqlSessionFactory
  19. */
  20. @Bean(name = "oracleSessionFactory")
  21. @Primary
  22. public SqlSessionFactory masterSqlSessionFactory(@Qualifier("oracleDataSource") DataSource dataSource) throws Exception {
  23. SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
  24. bean.setDataSource(dataSource);
  25. bean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/oracle/*.xml"));
  26. return bean.getObject();
  27. }
  28. /**
  29. * 创建事务
  30. *@param dataSource
  31. *@return DataSourceTransactionManager
  32. */
  33. @Bean(name = "oracleTransactionManager")
  34. @Primary
  35. public DataSourceTransactionManager masterDataSourceTransactionManager(@Qualifier("oracleDataSource") DataSource dataSource) {
  36. return new DataSourceTransactionManager(dataSource);
  37. }
  38. /**
  39. * 创建模板
  40. *@param sqlSessionFactory
  41. *@return SqlSessionTemplate
  42. */
  43. @Bean(name = "oracleSessionTemplate")
  44. @Primary
  45. public SqlSessionTemplate masterSqlSessionTemplate(@Qualifier("oracleSessionFactory") SqlSessionFactory sqlSessionFactory) {
  46. return new SqlSessionTemplate(sqlSessionFactory);
  47. }
  48. }

在service层添加@Transactional注解

  1. @Transactional(readOnly = true,rollbackFor = Exception.class,transactionManager = "clusterTransactionManager",isolation = Isolation.READ_UNCOMMITTED,propagation = Propagation.REQUIRED)

拓展

在微服务架构中可使用springcloud alibaba中的微服务seata中的@GlobalTransactional注解,其功能和用法与@Transactional差不多,不过@GlobalTransactional是做全局事务控制的,而@Transactional是非全局的。

JeecgBoot的定时任务

不带参的任务

  1. 首先新建一个任务类并实现Job接口,在其实现的方法上写上相应的任务,用于定时执行

示例代码:

  1. /**
  2. * 示例不带参定时任务
  3. *
  4. * @author Scott
  5. */
  6. @Slf4j
  7. public class SampleJob implements Job {
  8. @Override
  9. public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
  10. log.info(String.format(" Jeecg-Boot 普通定时任务 SampleJob ! 时间:" + DateUtils.getTimestamp()));
  11. }
  12. }
  1. 然后进入JeecgBoot后台添加定时任务

0N1AGMJF{W4D(M~RK%``)ZG.png

  1. 任务参数设置

image.png

带参的任务

  1. /**
  2. * 示例带参定时任务
  3. *
  4. * @Author Scott
  5. */
  6. @Slf4j
  7. public class SampleParamJob implements Job {
  8. /**
  9. * 若参数变量名修改 QuartzJobController中也需对应修改
  10. */
  11. private String parameter;
  12. public void setParameter(String parameter) {
  13. this.parameter = parameter;
  14. }
  15. @Override
  16. public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
  17. log.info(" Job Execution key:"+jobExecutionContext.getJobDetail().getKey());
  18. log.info( String.format("welcome %s! Jeecg-Boot 带参数定时任务 SampleParamJob ! 时间:" + DateUtils.now(), this.parameter));
  19. }
  20. }

实现类

  1. package org.jeecg.modules.quartz.service.impl;
  2. import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
  3. import lombok.extern.slf4j.Slf4j;
  4. import org.jeecg.common.constant.CommonConstant;
  5. import org.jeecg.common.exception.JeecgBootException;
  6. import org.jeecg.common.util.DateUtils;
  7. import org.jeecg.modules.quartz.entity.QuartzJob;
  8. import org.jeecg.modules.quartz.mapper.QuartzJobMapper;
  9. import org.jeecg.modules.quartz.service.IQuartzJobService;
  10. import org.quartz.*;
  11. import org.springframework.beans.factory.annotation.Autowired;
  12. import org.springframework.stereotype.Service;
  13. import org.springframework.transaction.annotation.Transactional;
  14. import java.util.Date;
  15. import java.util.List;
  16. /**
  17. * @Description: 定时任务在线管理
  18. * @Author: jeecg-boot
  19. * @Date: 2019-04-28
  20. * @Version: V1.1
  21. */
  22. @Slf4j
  23. @Service
  24. public class QuartzJobServiceImpl extends ServiceImpl<QuartzJobMapper, QuartzJob> implements IQuartzJobService {
  25. @Autowired
  26. private QuartzJobMapper quartzJobMapper;
  27. @Autowired
  28. private Scheduler scheduler;
  29. /**
  30. * 立即执行的任务分组
  31. */
  32. private static final String JOB_TEST_GROUP = "test_group";
  33. @Override
  34. public List<QuartzJob> findByJobClassName(String jobClassName) {
  35. return quartzJobMapper.findByJobClassName(jobClassName);
  36. }
  37. /**
  38. * 保存&启动定时任务
  39. */
  40. @Override
  41. @Transactional(rollbackFor = JeecgBootException.class)
  42. public boolean saveAndScheduleJob(QuartzJob quartzJob) {
  43. // DB设置修改
  44. quartzJob.setDelFlag(CommonConstant.DEL_FLAG_0);
  45. boolean success = this.save(quartzJob);
  46. if (success) {
  47. if (CommonConstant.STATUS_NORMAL.equals(quartzJob.getStatus())) {
  48. // 定时器添加
  49. this.schedulerAdd(quartzJob.getId(), quartzJob.getJobClassName().trim(), quartzJob.getCronExpression().trim(), quartzJob.getParameter());
  50. }
  51. }
  52. return success;
  53. }
  54. /**
  55. * 恢复定时任务
  56. */
  57. @Override
  58. @Transactional(rollbackFor = JeecgBootException.class)
  59. public boolean resumeJob(QuartzJob quartzJob) {
  60. schedulerDelete(quartzJob.getId());
  61. schedulerAdd(quartzJob.getId(), quartzJob.getJobClassName().trim(), quartzJob.getCronExpression().trim(), quartzJob.getParameter());
  62. quartzJob.setStatus(CommonConstant.STATUS_NORMAL);
  63. return this.updateById(quartzJob);
  64. }
  65. /**
  66. * 编辑&启停定时任务
  67. * @throws SchedulerException
  68. */
  69. @Override
  70. @Transactional(rollbackFor = JeecgBootException.class)
  71. public boolean editAndScheduleJob(QuartzJob quartzJob) throws SchedulerException {
  72. if (CommonConstant.STATUS_NORMAL.equals(quartzJob.getStatus())) {
  73. schedulerDelete(quartzJob.getId());
  74. schedulerAdd(quartzJob.getId(), quartzJob.getJobClassName().trim(), quartzJob.getCronExpression().trim(), quartzJob.getParameter());
  75. }else{
  76. scheduler.pauseJob(JobKey.jobKey(quartzJob.getId()));
  77. }
  78. return this.updateById(quartzJob);
  79. }
  80. /**
  81. * 删除&停止删除定时任务
  82. */
  83. @Override
  84. @Transactional(rollbackFor = JeecgBootException.class)
  85. public boolean deleteAndStopJob(QuartzJob job) {
  86. schedulerDelete(job.getId());
  87. boolean ok = this.removeById(job.getId());
  88. return ok;
  89. }
  90. @Override
  91. public void execute(QuartzJob quartzJob) throws Exception {
  92. String jobName = quartzJob.getJobClassName().trim();
  93. Date startDate = new Date();
  94. String ymd = DateUtils.date2Str(startDate,DateUtils.yyyymmddhhmmss.get());
  95. String identity = jobName + ymd;
  96. //3秒后执行 只执行一次
  97. // update-begin--author:sunjianlei ---- date:20210511--- for:定时任务立即执行,延迟3秒改成0.1秒-------
  98. startDate.setTime(startDate.getTime() + 100L);
  99. // update-end--author:sunjianlei ---- date:20210511--- for:定时任务立即执行,延迟3秒改成0.1秒-------
  100. // 定义一个Trigger
  101. SimpleTrigger trigger = (SimpleTrigger)TriggerBuilder.newTrigger()
  102. .withIdentity(identity, JOB_TEST_GROUP)
  103. .startAt(startDate)
  104. .build();
  105. // 构建job信息
  106. JobDetail jobDetail = JobBuilder.newJob(getClass(jobName).getClass()).withIdentity(identity).usingJobData("parameter", quartzJob.getParameter()).build();
  107. // 将trigger和 jobDetail 加入这个调度
  108. scheduler.scheduleJob(jobDetail, trigger);
  109. // 启动scheduler
  110. scheduler.start();
  111. }
  112. @Override
  113. @Transactional(rollbackFor = JeecgBootException.class)
  114. public void pause(QuartzJob quartzJob){
  115. schedulerDelete(quartzJob.getId());
  116. quartzJob.setStatus(CommonConstant.STATUS_DISABLE);
  117. this.updateById(quartzJob);
  118. }
  119. /**
  120. * 添加定时任务
  121. *
  122. * @param jobClassName
  123. * @param cronExpression
  124. * @param parameter
  125. */
  126. private void schedulerAdd(String id, String jobClassName, String cronExpression, String parameter) {
  127. try {
  128. // 启动调度器
  129. scheduler.start();
  130. // 构建job信息
  131. JobDetail jobDetail = JobBuilder.newJob(getClass(jobClassName).getClass()).withIdentity(id).usingJobData("parameter", parameter).build();
  132. // 表达式调度构建器(即任务执行的时间)
  133. CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(cronExpression);
  134. // 按新的cronExpression表达式构建一个新的trigger
  135. CronTrigger trigger = TriggerBuilder.newTrigger().withIdentity(id).withSchedule(scheduleBuilder).build();
  136. scheduler.scheduleJob(jobDetail, trigger);
  137. } catch (SchedulerException e) {
  138. throw new JeecgBootException("创建定时任务失败", e);
  139. } catch (RuntimeException e) {
  140. throw new JeecgBootException(e.getMessage(), e);
  141. }catch (Exception e) {
  142. throw new JeecgBootException("后台找不到该类名:" + jobClassName, e);
  143. }
  144. }
  145. /**
  146. * 删除定时任务
  147. *
  148. * @param id
  149. */
  150. private void schedulerDelete(String id) {
  151. try {
  152. scheduler.pauseTrigger(TriggerKey.triggerKey(id));
  153. scheduler.unscheduleJob(TriggerKey.triggerKey(id));
  154. scheduler.deleteJob(JobKey.jobKey(id));
  155. } catch (Exception e) {
  156. log.error(e.getMessage(), e);
  157. throw new JeecgBootException("删除定时任务失败");
  158. }
  159. }
  160. private static Job getClass(String classname) throws Exception {
  161. Class<?> class1 = Class.forName(classname);
  162. return (Job) class1.newInstance();
  163. }
  164. }

Cron表达式

image.png
七个参数,从第一个到最后一个分表表示秒、分、时、日、月、周、年
-:区间
/:循环
,:第几
?:不设置
*:每
日和周只能设置其中之一

JeecgBoot的系统通知接口

短信通知接口

DySmsHelper.sendSms(mobile, obj,DySmsEnum.REGISTER_TEMPLATE_CODE)
mobile:短信接收方的手机号
obj:模板中的变量替换JSON串,如模板内容为”亲爱的${name},您的验证码为${code}”
DySmsEnum.REGISTER_TEMPLATE_CODE:枚举类中的变量,包含短信签名(signName)、短信模板code(templateCode)、短信模板必需的数据名称(keys),多个key以逗号分隔
需要注意的是这里的签名和code是短信服务里的,而不是下图中的code,目前jeecgboot使用的短信服务是阿里的
image.png

  1. /**
  2. * Created on 17/6/7.
  3. * 短信API产品的DEMO程序,工程中包含了一个SmsDemo类,直接通过
  4. * 执行main函数即可体验短信产品API功能(只需要将AK替换成开通了云通信-短信产品功能的AK即可)
  5. * 工程依赖了2个jar包(存放在工程的libs目录下)
  6. * 1:aliyun-java-sdk-core.jar
  7. * 2:aliyun-java-sdk-dysmsapi.jar
  8. *
  9. * 备注:Demo工程编码采用UTF-8
  10. * 国际短信发送请勿参照此DEMO
  11. */
  12. public class DySmsHelper {
  13. private final static Logger logger=LoggerFactory.getLogger(DySmsHelper.class);
  14. //产品名称:云通信短信API产品,开发者无需替换
  15. static final String product = "Dysmsapi";
  16. //产品域名,开发者无需替换
  17. static final String domain = "dysmsapi.aliyuncs.com";
  18. // TODO 此处需要替换成开发者自己的AK(在阿里云访问控制台寻找)
  19. static String accessKeyId;
  20. static String accessKeySecret;
  21. public static void setAccessKeyId(String accessKeyId) {
  22. DySmsHelper.accessKeyId = accessKeyId;
  23. }
  24. public static void setAccessKeySecret(String accessKeySecret) {
  25. DySmsHelper.accessKeySecret = accessKeySecret;
  26. }
  27. public static String getAccessKeyId() {
  28. return accessKeyId;
  29. }
  30. public static String getAccessKeySecret() {
  31. return accessKeySecret;
  32. }
  33. public static boolean sendSms(String phone,JSONObject templateParamJson,DySmsEnum dySmsEnum) throws ClientException {
  34. //可自助调整超时时间
  35. System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
  36. System.setProperty("sun.net.client.defaultReadTimeout", "10000");
  37. //update-begin-author:taoyan date:20200811 for:配置类数据获取
  38. StaticConfig staticConfig = SpringContextUtils.getBean(StaticConfig.class);
  39. setAccessKeyId(staticConfig.getAccessKeyId());
  40. setAccessKeySecret(staticConfig.getAccessKeySecret());
  41. //update-end-author:taoyan date:20200811 for:配置类数据获取
  42. //初始化acsClient,暂不支持region化
  43. IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
  44. DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
  45. IAcsClient acsClient = new DefaultAcsClient(profile);
  46. //验证json参数
  47. validateParam(templateParamJson,dySmsEnum);
  48. //组装请求对象-具体描述见控制台-文档部分内容
  49. SendSmsRequest request = new SendSmsRequest();
  50. //必填:待发送手机号
  51. request.setPhoneNumbers(phone);
  52. //必填:短信签名-可在短信控制台中找到
  53. request.setSignName(dySmsEnum.getSignName());
  54. //必填:短信模板-可在短信控制台中找到
  55. request.setTemplateCode(dySmsEnum.getTemplateCode());
  56. //可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
  57. request.setTemplateParam(templateParamJson.toJSONString());
  58. //选填-上行短信扩展码(无特殊需求用户请忽略此字段)
  59. //request.setSmsUpExtendCode("90997");
  60. //可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
  61. //request.setOutId("yourOutId");
  62. boolean result = false;
  63. //hint 此处可能会抛出异常,注意catch
  64. SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
  65. logger.info("短信接口返回的数据----------------");
  66. logger.info("{Code:" + sendSmsResponse.getCode()+",Message:" + sendSmsResponse.getMessage()+",RequestId:"+ sendSmsResponse.getRequestId()+",BizId:"+sendSmsResponse.getBizId()+"}");
  67. if ("OK".equals(sendSmsResponse.getCode())) {
  68. result = true;
  69. }
  70. return result;
  71. }
  72. private static void validateParam(JSONObject templateParamJson,DySmsEnum dySmsEnum) {
  73. String keys = dySmsEnum.getKeys();
  74. String [] keyArr = keys.split(",");
  75. for(String item :keyArr) {
  76. if(!templateParamJson.containsKey(item)) {
  77. throw new RuntimeException("模板缺少参数:"+item);
  78. }
  79. }
  80. }
  81. // public static void main(String[] args) throws ClientException, InterruptedException {
  82. // JSONObject obj = new JSONObject();
  83. // obj.put("code", "1234");
  84. // sendSms("13800138000", obj, DySmsEnum.FORGET_PASSWORD_TEMPLATE_CODE);
  85. // }
  86. }

邮件通知接口

  1. JavaMailSender mailSender = (JavaMailSender) SpringContextUtils.getBean("mailSender");
  2. SimpleMailMessage message = new SimpleMailMessage();
  3. // 设置发送方邮箱地址
  4. message.setFrom(emailFrom);//发件人邮箱
  5. message.setTo(es_receiver);//收件人邮箱
  6. message.setSubject(es_title);//标题
  7. message.setText(es_content);//内容
  8. mailSender.send(message);

或者

  1. EmailSendMsgHandle emailSendMsgHandle = new EmailSendMsgHandle();
  2. String es_receiver = "rongcw@upcif.com";
  3. String es_title = "jeecg测试邮件";
  4. String es_content = "测试内容";
  5. emailSendMsgHandle.SendMsg(es_receiver ,es_title ,es_content );

image.png

系统消息提醒

调用ISysBaseAPI接口发送系统消息,message中发送方和接收方为系统用户的账户名

  1. /**
  2. * 1发送系统消息
  3. * @param message 使用构造器赋值参数 如果不设置category(消息类型)则默认为2 发送系统消息
  4. */
  5. void sendSysAnnouncement(MessageDTO message);
  6. /**
  7. * 2发送消息 附带业务参数
  8. * @param message 使用构造器赋值参数
  9. */
  10. void sendBusAnnouncement(BusMessageDTO message);
  11. /**
  12. * 3通过模板发送消息
  13. * @param message 使用构造器赋值参数
  14. */
  15. void sendTemplateAnnouncement(TemplateMessageDTO message);
  16. /**
  17. * 4通过模板发送消息 附带业务参数
  18. * @param message 使用构造器赋值参数
  19. */
  20. void sendBusTemplateAnnouncement(BusTemplateMessageDTO message);
  21. /**
  22. * 5通过消息中心模板,生成推送内容
  23. * @param templateDTO 使用构造器赋值参数
  24. * @return
  25. */
  26. String parseTemplateByCode(TemplateDTO templateDTO);
  1. MessageDTO message2 = new MessageDTO();
  2. message2.setFromUser("jeecg");
  3. message2.setToUser("admin,张小红");
  4. message2.setTitle("测试");
  5. try {
  6. sysBaseAPI.sendSysAnnouncement(message2);
  7. //sysBaseAPI.sendTemplateAnnouncement(message);
  8. }catch (Exception e){
  9. e.printStackTrace();
  10. }

image.png
image.png
也可通过模板进行系统消息发送

  1. TemplateMessageDTO message = new TemplateMessageDTO();
  2. HashMap<String,String> map = new HashMap<String,String>();
  3. map.put("code","78946");
  4. message.setTemplateCode("SMS_TEST"); //模板code
  5. message.setFromUser("jeecg");
  6. message.setToUser("admin,张小红");
  7. message.setTemplateParam(map);
  8. try {
  9. sysBaseAPI.sendTemplateAnnouncement(message);
  10. }catch (Exception e){
  11. e.printStackTrace();
  12. }

image.png

  1. public void sendTemplateAnnouncement(TemplateMessageDTO message) {
  2. String templateCode = message.getTemplateCode();
  3. String title = message.getTitle();
  4. Map<String,String> map = message.getTemplateParam();
  5. String fromUser = message.getFromUser();
  6. String toUser = message.getToUser();
  7. List<SysMessageTemplate> sysSmsTemplates = sysMessageTemplateService.selectByCode(templateCode);
  8. if(sysSmsTemplates==null||sysSmsTemplates.size()==0){
  9. throw new JeecgBootException("消息模板不存在,模板编码:"+templateCode);
  10. }
  11. SysMessageTemplate sysSmsTemplate = sysSmsTemplates.get(0);
  12. //模板标题
  13. title = title==null?sysSmsTemplate.getTemplateName():title;
  14. //模板内容
  15. String content = sysSmsTemplate.getTemplateContent();
  16. if(map!=null) {
  17. for (Map.Entry<String, String> entry : map.entrySet()) {
  18. String str = "${" + entry.getKey() + "}";
  19. if(oConvertUtils.isNotEmpty(title)){
  20. title = title.replace(str, entry.getValue());
  21. }
  22. content = content.replace(str, entry.getValue());
  23. }
  24. }
  25. SysAnnouncement announcement = new SysAnnouncement();
  26. announcement.setTitile(title);
  27. announcement.setMsgContent(content);
  28. announcement.setSender(fromUser);
  29. announcement.setPriority(CommonConstant.PRIORITY_M);
  30. announcement.setMsgType(CommonConstant.MSG_TYPE_UESR);
  31. announcement.setSendStatus(CommonConstant.HAS_SEND);
  32. announcement.setSendTime(new Date());
  33. announcement.setMsgCategory(CommonConstant.MSG_CATEGORY_2);
  34. announcement.setDelFlag(String.valueOf(CommonConstant.DEL_FLAG_0));
  35. sysAnnouncementMapper.insert(announcement);
  36. // 2.插入用户通告阅读标记表记录
  37. String userId = toUser;
  38. String[] userIds = userId.split(",");
  39. String anntId = announcement.getId();
  40. for(int i=0;i<userIds.length;i++) {
  41. if(oConvertUtils.isNotEmpty(userIds[i])) {
  42. SysUser sysUser = userMapper.getUserByName(userIds[i]);
  43. if(sysUser==null) {
  44. continue;
  45. }
  46. SysAnnouncementSend announcementSend = new SysAnnouncementSend();
  47. announcementSend.setAnntId(anntId);
  48. announcementSend.setUserId(sysUser.getId());
  49. announcementSend.setReadFlag(CommonConstant.NO_READ_FLAG);
  50. sysAnnouncementSendMapper.insert(announcementSend);
  51. JSONObject obj = new JSONObject();
  52. obj.put(WebsocketConst.MSG_CMD, WebsocketConst.CMD_USER);
  53. obj.put(WebsocketConst.MSG_USER_ID, sysUser.getId());
  54. obj.put(WebsocketConst.MSG_ID, announcement.getId());
  55. obj.put(WebsocketConst.MSG_TXT, announcement.getTitile());
  56. webSocket.sendMessage(sysUser.getId(), obj.toJSONString());
  57. }
  58. }
  59. try {
  60. // 同步企业微信、钉钉的消息通知
  61. dingtalkService.sendActionCardMessage(announcement, true);
  62. wechatEnterpriseService.sendTextCardMessage(announcement, true);
  63. } catch (Exception e) {
  64. log.error("同步发送第三方APP消息失败!", e);
  65. }
  66. }

JeecgBoot的消息推送接口

JeecgBoot提供了根据消息模板实现消息推送的功能,类似消息中间件功能,数据推送添加至消息表中,定时任务自动推送。

使用步骤

  1. 在消息中心-模板管理中创建所需模板

image.png

  1. 引入推送工具类

org.jeecg.modules.message.util.PushMsgUtil.java

  1. 调用接口推送消息

//当模板内容中有参数时,需添加map为内容中参数赋值,如果模板消息中没有参数,可省略

  1. Map<String, String> map = new HashMap();
  2. map.put("bpm_name","请假审批");
  3. map.put("bpm_task","部门经理审批");
  4. map.put("remark","");
  5. //调用消息推送保存接口
  6. boolean is_sendSuccess = pushMsgUtil.sendMessage("2", "789456", map,"rongcw@upcif.com");

image.png
image.png

参数说明:
image.png
需要注意的是,这里的receiver接收人,以什么样的消息类型就填写什么样的方式,比如邮箱类型的就填邮箱,否则会失败。
消息保存后之后,需要在定时任务中启动消息发送任务,才可进一步发送消息

  1. package org.jeecg.modules.message.job;
  2. import java.util.List;
  3. import org.jeecg.common.util.DateUtils;
  4. import org.jeecg.modules.message.entity.SysMessage;
  5. import org.jeecg.modules.message.handle.ISendMsgHandle;
  6. import org.jeecg.modules.message.handle.enums.SendMsgStatusEnum;
  7. import org.jeecg.modules.message.handle.enums.SendMsgTypeEnum;
  8. import org.jeecg.modules.message.service.ISysMessageService;
  9. import org.quartz.Job;
  10. import org.quartz.JobExecutionContext;
  11. import org.quartz.JobExecutionException;
  12. import org.springframework.beans.factory.annotation.Autowired;
  13. import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  14. import lombok.extern.slf4j.Slf4j;
  15. /**
  16. * 发送消息任务
  17. */
  18. @Slf4j
  19. public class SendMsgJob implements Job {
  20. @Autowired
  21. private ISysMessageService sysMessageService;
  22. @Override
  23. public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
  24. log.info(String.format(" Jeecg-Boot 发送消息任务 SendMsgJob ! 时间:" + DateUtils.getTimestamp()));
  25. // 1.读取消息中心数据,只查询未发送的和发送失败不超过次数的
  26. QueryWrapper<SysMessage> queryWrapper = new QueryWrapper<SysMessage>();
  27. queryWrapper.eq("es_send_status", SendMsgStatusEnum.WAIT.getCode())
  28. .or(i -> i.eq("es_send_status", SendMsgStatusEnum.FAIL.getCode()).lt("es_send_num", 6));
  29. List<SysMessage> sysMessages = sysMessageService.list(queryWrapper);
  30. System.out.println(sysMessages);
  31. // 2.根据不同的类型走不通的发送实现类
  32. for (SysMessage sysMessage : sysMessages) {
  33. ISendMsgHandle sendMsgHandle = null;
  34. try {
  35. if (sysMessage.getEsType().equals(SendMsgTypeEnum.EMAIL.getType())) {
  36. sendMsgHandle = (ISendMsgHandle) Class.forName(SendMsgTypeEnum.EMAIL.getImplClass()).newInstance();
  37. } else if (sysMessage.getEsType().equals(SendMsgTypeEnum.SMS.getType())) {
  38. sendMsgHandle = (ISendMsgHandle) Class.forName(SendMsgTypeEnum.SMS.getImplClass()).newInstance();
  39. } else if (sysMessage.getEsType().equals(SendMsgTypeEnum.WX.getType())) {
  40. sendMsgHandle = (ISendMsgHandle) Class.forName(SendMsgTypeEnum.WX.getImplClass()).newInstance();
  41. }
  42. } catch (Exception e) {
  43. log.error(e.getMessage(),e);
  44. }
  45. Integer sendNum = sysMessage.getEsSendNum();
  46. try {
  47. sendMsgHandle.SendMsg(sysMessage.getEsReceiver(), sysMessage.getEsTitle(),
  48. sysMessage.getEsContent().toString());
  49. // 发送消息成功
  50. sysMessage.setEsSendStatus(SendMsgStatusEnum.SUCCESS.getCode());
  51. } catch (Exception e) {
  52. e.printStackTrace();
  53. // 发送消息出现异常
  54. sysMessage.setEsSendStatus(SendMsgStatusEnum.FAIL.getCode());
  55. }
  56. sysMessage.setEsSendNum(++sendNum);
  57. // 发送结果回写到数据库
  58. sysMessageService.updateById(sysMessage);
  59. }
  60. }
  61. }

其他实现类

org.jeecg.modules.message.handle.impl.EmailSendMsgHandle 邮件推送 已实现
org.jeecg.modules.message.handle.impl.SmsSendMsgHandle 短信推送 未实现
org.jeecg.modules.message.handle.impl.WxSendMsgHandle 微信推送 未实现

短信接口配置

阿里短信服务文档

可通过支付宝或者淘宝账户注册阿里云账户,同时提供了专门阿里云服务app

获取阿里短信key、签名和模板

获取AccessKey

进入阿里短信服务工作台,点击箭头指向的按钮
image.png

进入如下界面,查看创建的key,若没有则需创建所需的key

image.png

可使用手机发送验证码创建,保存Ak信息则会生成一个csv文件在本地磁盘上,文件内容对应着key id 和 secret

image.png

创建短信签名和短信模板

image.png

根据相关资料填写完信息后,等待审核成功

image.png

image.png

审核成功后,进入签名列表和模板列表查看,需要记住的是签名名称和模板CODE,后续配置会用到

image.png

SpringBoot集成阿里短信服务

在pom文件中导入相关依赖

  1. <repositories>
  2. <repository>
  3. <id>aliyun</id>
  4. <name>aliyun Repository</name>
  5. <url>https://maven.aliyun.com/repository/public</url>
  6. <snapshots>
  7. <enabled>false</enabled>
  8. </snapshots>
  9. </repository>
  10. </repositories>

或者

  1. <dependency>
  2. <groupId>com.aliyun</groupId>
  3. <artifactId>aliyun-java-sdk-core</artifactId>
  4. <version>4.1.0</version>
  5. <exclusions>
  6. <exclusion>
  7. <artifactId>commons-codec</artifactId>
  8. <groupId>commons-codec</groupId>
  9. </exclusion>
  10. <exclusion>
  11. <artifactId>activation</artifactId>
  12. <groupId>javax.activation</groupId>
  13. </exclusion>
  14. </exclusions>
  15. </dependency>
  16. <dependency>
  17. <groupId>com.aliyun</groupId>
  18. <artifactId>aliyun-java-sdk-dysmsapi</artifactId>
  19. <version>1.1.0</version>
  20. </dependency>

修改配置文件

  1. jeecg:
  2. #阿里云oss存储和大鱼短信秘钥配置
  3. oss:
  4. accessKey: **********************
  5. secretKey: **********************
  6. endpoint: oss-cn-beijing.aliyuncs.com
  7. bucketName: jeecgdev
  8. staticDomain: https://static.jeecg.com

获取配置文件短信配置信息

  1. package org.jeecg.config;
  2. import lombok.Data;
  3. import org.springframework.beans.factory.annotation.Value;
  4. import org.springframework.stereotype.Component;
  5. /**
  6. * 设置静态参数初始化
  7. */
  8. @Component
  9. @Data
  10. public class StaticConfig {
  11. @Value("${jeecg.oss.accessKey}")
  12. private String accessKeyId;
  13. @Value("${jeecg.oss.secretKey}")
  14. private String accessKeySecret;
  15. @Value(value = "${spring.mail.username}")
  16. private String emailFrom;
  17. /**
  18. * 签名密钥串
  19. */
  20. @Value(value = "${jeecg.signatureSecret}")
  21. private String signatureSecret;
  22. /*@Bean
  23. public void initStatic() {
  24. DySmsHelper.setAccessKeyId(accessKeyId);
  25. DySmsHelper.setAccessKeySecret(accessKeySecret);
  26. EmailSendMsgHandle.setEmailFrom(emailFrom);
  27. }*/
  28. }

短信发送接口实现类

  1. package org.jeecg.common.util;
  2. import org.jeecg.config.StaticConfig;
  3. import org.slf4j.Logger;
  4. import org.slf4j.LoggerFactory;
  5. import com.alibaba.fastjson.JSONObject;
  6. import com.aliyuncs.DefaultAcsClient;
  7. import com.aliyuncs.IAcsClient;
  8. import com.aliyuncs.dysmsapi.model.v20170525.SendSmsRequest;
  9. import com.aliyuncs.dysmsapi.model.v20170525.SendSmsResponse;
  10. import com.aliyuncs.exceptions.ClientException;
  11. import com.aliyuncs.profile.DefaultProfile;
  12. import com.aliyuncs.profile.IClientProfile;
  13. /**
  14. * Created on 17/6/7.
  15. * 短信API产品的DEMO程序,工程中包含了一个SmsDemo类,直接通过
  16. * 执行main函数即可体验短信产品API功能(只需要将AK替换成开通了云通信-短信产品功能的AK即可)
  17. * 工程依赖了2个jar包(存放在工程的libs目录下)
  18. * 1:aliyun-java-sdk-core.jar
  19. * 2:aliyun-java-sdk-dysmsapi.jar
  20. *
  21. * 备注:Demo工程编码采用UTF-8
  22. * 国际短信发送请勿参照此DEMO
  23. */
  24. public class DySmsHelper {
  25. private final static Logger logger=LoggerFactory.getLogger(DySmsHelper.class);
  26. //产品名称:云通信短信API产品,开发者无需替换
  27. static final String product = "Dysmsapi";
  28. //产品域名,开发者无需替换
  29. static final String domain = "dysmsapi.aliyuncs.com";
  30. // TODO 此处需要替换成开发者自己的AK(在阿里云访问控制台寻找)
  31. static String accessKeyId;
  32. static String accessKeySecret;
  33. public static void setAccessKeyId(String accessKeyId) {
  34. DySmsHelper.accessKeyId = accessKeyId;
  35. }
  36. public static void setAccessKeySecret(String accessKeySecret) {
  37. DySmsHelper.accessKeySecret = accessKeySecret;
  38. }
  39. public static String getAccessKeyId() {
  40. return accessKeyId;
  41. }
  42. public static String getAccessKeySecret() {
  43. return accessKeySecret;
  44. }
  45. public static boolean sendSms(String phone,JSONObject templateParamJson,DySmsEnum dySmsEnum) throws ClientException {
  46. //可自助调整超时时间
  47. System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
  48. System.setProperty("sun.net.client.defaultReadTimeout", "10000");
  49. //update-begin-author:taoyan date:20200811 for:配置类数据获取
  50. StaticConfig staticConfig = SpringContextUtils.getBean(StaticConfig.class);
  51. setAccessKeyId(staticConfig.getAccessKeyId());
  52. setAccessKeySecret(staticConfig.getAccessKeySecret());
  53. //update-end-author:taoyan date:20200811 for:配置类数据获取
  54. //初始化acsClient,暂不支持region化
  55. IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
  56. DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
  57. IAcsClient acsClient = new DefaultAcsClient(profile);
  58. //验证json参数
  59. validateParam(templateParamJson,dySmsEnum);
  60. //组装请求对象-具体描述见控制台-文档部分内容
  61. SendSmsRequest request = new SendSmsRequest();
  62. //必填:待发送手机号
  63. request.setPhoneNumbers(phone);
  64. //必填:短信签名-可在短信控制台中找到
  65. request.setSignName(dySmsEnum.getSignName());
  66. //必填:短信模板-可在短信控制台中找到
  67. request.setTemplateCode(dySmsEnum.getTemplateCode());
  68. //可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
  69. request.setTemplateParam(templateParamJson.toJSONString());
  70. //选填-上行短信扩展码(无特殊需求用户请忽略此字段)
  71. //request.setSmsUpExtendCode("90997");
  72. //可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
  73. //request.setOutId("yourOutId");
  74. boolean result = false;
  75. //hint 此处可能会抛出异常,注意catch
  76. SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
  77. logger.info("短信接口返回的数据----------------");
  78. logger.info("{Code:" + sendSmsResponse.getCode()+",Message:" + sendSmsResponse.getMessage()+",RequestId:"+ sendSmsResponse.getRequestId()+",BizId:"+sendSmsResponse.getBizId()+"}");
  79. if ("OK".equals(sendSmsResponse.getCode())) {
  80. result = true;
  81. }
  82. return result;
  83. }
  84. private static void validateParam(JSONObject templateParamJson,DySmsEnum dySmsEnum) {
  85. String keys = dySmsEnum.getKeys();
  86. String [] keyArr = keys.split(",");
  87. for(String item :keyArr) {
  88. if(!templateParamJson.containsKey(item)) {
  89. throw new RuntimeException("模板缺少参数:"+item);
  90. }
  91. }
  92. }
  93. // public static void main(String[] args) throws ClientException, InterruptedException {
  94. // JSONObject obj = new JSONObject();
  95. // obj.put("code", "1234");
  96. // sendSms("13800138000", obj, DySmsEnum.FORGET_PASSWORD_TEMPLATE_CODE);
  97. // }
  98. }

调用短信发送接口

  1. JSONObject templateParamJson = new JSONObject();
  2. templateParamJson.put("code","123456");
  3. try {
  4. DySmsHelper.sendSms("17687475079", templateParamJson,DySmsEnum.TEST_CODE);
  5. }catch (Exception e){
  6. e.printStackTrace();
  7. }

接口上送参数说明

名称 类型 说明
phone String 手机号
templateParamJson JSONObject 短信内容
dySmsEnum DySmsEnum 短信模板

注意这里的短信模板是指短信服务上的模板,而不是系统中的消息模板,否则会因找不到模板而报

dySmsEnum短信枚举信息类

  1. package org.jeecg.common.util;
  2. import org.apache.commons.lang3.StringUtils;
  3. public enum DySmsEnum {
  4. TEST_CODE("SMS_205466924","小伟考勤","code"),
  5. LOGIN_TEMPLATE_CODE("SMS_175435174","JEECG","code"),
  6. FORGET_PASSWORD_TEMPLATE_CODE("SMS_175435174","JEECG","code"),
  7. REGISTER_TEMPLATE_CODE("SMS_175430166","JEECG","code"),
  8. /**会议通知*/
  9. MEET_NOTICE_TEMPLATE_CODE("SMS_201480469","H5活动之家","username,title,minute,time"),
  10. /**我的计划通知*/
  11. PLAN_NOTICE_TEMPLATE_CODE("SMS_201470515","H5活动之家","username,title,time");
  12. /**
  13. * 短信模板编码
  14. */
  15. private String templateCode;
  16. /**
  17. * 签名
  18. */
  19. private String signName;
  20. /**
  21. * 短信模板必需的数据名称,多个key以逗号分隔,此处配置作为校验
  22. */
  23. private String keys;
  24. private DySmsEnum(String templateCode,String signName,String keys) {
  25. this.templateCode = templateCode;
  26. this.signName = signName;
  27. this.keys = keys;
  28. }
  29. public String getTemplateCode() {
  30. return templateCode;
  31. }
  32. public void setTemplateCode(String templateCode) {
  33. this.templateCode = templateCode;
  34. }
  35. public String getSignName() {
  36. return signName;
  37. }
  38. public void setSignName(String signName) {
  39. this.signName = signName;
  40. }
  41. public String getKeys() {
  42. return keys;
  43. }
  44. public void setKeys(String keys) {
  45. this.keys = keys;
  46. }
  47. public static DySmsEnum toEnum(String templateCode) {
  48. if(StringUtils.isEmpty(templateCode)){
  49. return null;
  50. }
  51. for(DySmsEnum item : DySmsEnum.values()) {
  52. if(item.getTemplateCode().equals(templateCode)) {
  53. return item;
  54. }
  55. }
  56. return null;
  57. }
  58. }

jeecgboot实现短信推送功能

jeecgboot的推送功能实际是将要推送的消息保存到数据库中,然后通过一个定时任务去定时的将数据库表中未发送或者发送失败次数超过六次以上的消息进行定时发送,保存的消息可通过自定义的模板,讲所需要的参数传进去生成消息,jeecgboot未能实现短信推送的原因就在这里,因为保存的是一整条完整消息,不需要通过传参传入到短信服务给我们的模板中

解决办法

  1. 方法一:在短信服务申请一个全局变量的短信模板,后端只需要将短信模板和短信签名写死,即可将数据库的消息进行推送问题,各个短信运营商不支持全局变量的短信模板,而且即便添加了文字 如:系统消息:{message}这样的模板也是行不通的,客服给的说法是{message}这个变量的意义太广泛
  2. 方法二:可通过调用某些云服务平台提供的短信接口来实现短信发送,只需要我们将发送的内容传过去即可发送短信,目前这种方法是满足jeecgboot的短信推送功能的

    邮箱接口配置

    获取邮箱服务密钥(以QQ邮箱服务为例)

进入QQ邮箱

image.png

开启相关服务获取密钥,或通过点击生成授权码获取密钥

image.png

SpringBoot集成邮箱服务

在pom文件中引入邮箱服务依赖

  1. <resources>
  2. <resource>
  3. <directory>src/main/resources</directory>
  4. <filtering>true</filtering>
  5. </resource>
  6. </resources>

或者

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-mail</artifactId>
  4. </dependency>

修改配置文件

  1. spring:
  2. mail:
  3. host: smtp.qq.com #邮箱服务类型,我这选的是QQ邮箱服务
  4. username: ***************** #邮箱地址
  5. password: ***************** #邮箱密钥
  6. properties:
  7. mail:
  8. smtp:
  9. auth: true
  10. starttls:
  11. enable: true
  12. required: true

获取配置文件邮箱配置信息

  1. package org.jeecg.config;
  2. import lombok.Data;
  3. import org.springframework.beans.factory.annotation.Value;
  4. import org.springframework.stereotype.Component;
  5. /**
  6. * 设置静态参数初始化
  7. */
  8. @Component
  9. @Data
  10. public class StaticConfig {
  11. @Value("${jeecg.oss.accessKey}")
  12. private String accessKeyId;
  13. @Value("${jeecg.oss.secretKey}")
  14. private String accessKeySecret;
  15. @Value(value = "${spring.mail.username}")
  16. private String emailFrom;
  17. /**
  18. * 签名密钥串
  19. */
  20. @Value(value = "${jeecg.signatureSecret}")
  21. private String signatureSecret;
  22. /*@Bean
  23. public void initStatic() {
  24. DySmsHelper.setAccessKeyId(accessKeyId);
  25. DySmsHelper.setAccessKeySecret(accessKeySecret);
  26. EmailSendMsgHandle.setEmailFrom(emailFrom);
  27. }*/
  28. }

这里需要注意的是,获取密钥是通过mailSender这个bean类去获取的

  1. protected <T> T doGetBean(String name, @Nullable Class<T> requiredType, @Nullable Object[] args, boolean typeCheckOnly) throws BeansException {
  2. String beanName = this.transformedBeanName(name);
  3. Object sharedInstance = this.getSingleton(beanName);
  4. Object bean;
  5. if (sharedInstance != null && args == null) {
  6. if (this.logger.isTraceEnabled()) {
  7. if (this.isSingletonCurrentlyInCreation(beanName)) {
  8. this.logger.trace("Returning eagerly cached instance of singleton bean '" + beanName + "' that is not fully initialized yet - a consequence of a circular reference");
  9. } else {
  10. this.logger.trace("Returning cached instance of singleton bean '" + beanName + "'");
  11. }
  12. }
  13. bean = this.getObjectForBeanInstance(sharedInstance, name, beanName, (RootBeanDefinition)null);
  14. } else {
  15. if (this.isPrototypeCurrentlyInCreation(beanName)) {
  16. throw new BeanCurrentlyInCreationException(beanName);
  17. }
  18. BeanFactory parentBeanFactory = this.getParentBeanFactory();
  19. if (parentBeanFactory != null && !this.containsBeanDefinition(beanName)) {
  20. String nameToLookup = this.originalBeanName(name);
  21. if (parentBeanFactory instanceof AbstractBeanFactory) {
  22. return ((AbstractBeanFactory)parentBeanFactory).doGetBean(nameToLookup, requiredType, args, typeCheckOnly);
  23. }
  24. if (args != null) {
  25. return parentBeanFactory.getBean(nameToLookup, args);
  26. }
  27. if (requiredType != null) {
  28. return parentBeanFactory.getBean(nameToLookup, requiredType);
  29. }
  30. return parentBeanFactory.getBean(nameToLookup);
  31. }
  32. if (!typeCheckOnly) {
  33. this.markBeanAsCreated(beanName);
  34. }
  35. try {
  36. RootBeanDefinition mbd = this.getMergedLocalBeanDefinition(beanName);
  37. this.checkMergedBeanDefinition(mbd, beanName, args);
  38. String[] dependsOn = mbd.getDependsOn();
  39. String[] var11;
  40. if (dependsOn != null) {
  41. var11 = dependsOn;
  42. int var12 = dependsOn.length;
  43. for(int var13 = 0; var13 < var12; ++var13) {
  44. String dep = var11[var13];
  45. if (this.isDependent(beanName, dep)) {
  46. throw new BeanCreationException(mbd.getResourceDescription(), beanName, "Circular depends-on relationship between '" + beanName + "' and '" + dep + "'");
  47. }
  48. this.registerDependentBean(dep, beanName);
  49. try {
  50. this.getBean(dep);
  51. } catch (NoSuchBeanDefinitionException var24) {
  52. throw new BeanCreationException(mbd.getResourceDescription(), beanName, "'" + beanName + "' depends on missing bean '" + dep + "'", var24);
  53. }
  54. }
  55. }
  56. if (mbd.isSingleton()) {
  57. sharedInstance = this.getSingleton(beanName, () -> {
  58. try {
  59. return this.createBean(beanName, mbd, args);
  60. } catch (BeansException var5) {
  61. this.destroySingleton(beanName);
  62. throw var5;
  63. }
  64. });
  65. bean = this.getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
  66. } else if (mbd.isPrototype()) {
  67. var11 = null;
  68. Object prototypeInstance;
  69. try {
  70. this.beforePrototypeCreation(beanName);
  71. prototypeInstance = this.createBean(beanName, mbd, args);
  72. } finally {
  73. this.afterPrototypeCreation(beanName);
  74. }
  75. bean = this.getObjectForBeanInstance(prototypeInstance, name, beanName, mbd);
  76. } else {
  77. String scopeName = mbd.getScope();
  78. if (!StringUtils.hasLength(scopeName)) {
  79. throw new IllegalStateException("No scope name defined for bean ´" + beanName + "'");
  80. }
  81. Scope scope = (Scope)this.scopes.get(scopeName);
  82. if (scope == null) {
  83. throw new IllegalStateException("No Scope registered for scope name '" + scopeName + "'");
  84. }
  85. try {
  86. Object scopedInstance = scope.get(beanName, () -> {
  87. this.beforePrototypeCreation(beanName);
  88. Object var4;
  89. try {
  90. var4 = this.createBean(beanName, mbd, args);
  91. } finally {
  92. this.afterPrototypeCreation(beanName);
  93. }
  94. return var4;
  95. });
  96. bean = this.getObjectForBeanInstance(scopedInstance, name, beanName, mbd);
  97. } catch (IllegalStateException var23) {
  98. throw new BeanCreationException(beanName, "Scope '" + scopeName + "' is not active for the current thread; consider defining a scoped proxy for this bean if you intend to refer to it from a singleton", var23);
  99. }
  100. }
  101. } catch (BeansException var26) {
  102. this.cleanupAfterBeanCreationFailure(beanName);
  103. throw var26;
  104. }
  105. }
  106. if (requiredType != null && !requiredType.isInstance(bean)) {
  107. try {
  108. T convertedBean = this.getTypeConverter().convertIfNecessary(bean, requiredType);
  109. if (convertedBean == null) {
  110. throw new BeanNotOfRequiredTypeException(name, requiredType, bean.getClass());
  111. } else {
  112. return convertedBean;
  113. }
  114. } catch (TypeMismatchException var25) {
  115. if (this.logger.isTraceEnabled()) {
  116. this.logger.trace("Failed to convert bean '" + name + "' to required type '" + ClassUtils.getQualifiedName(requiredType) + "'", var25);
  117. }
  118. throw new BeanNotOfRequiredTypeException(name, requiredType, bean.getClass());
  119. }
  120. } else {
  121. return bean;
  122. }
  123. }
  1. @Nullable
  2. protected Object getSingleton(String beanName, boolean allowEarlyReference) {
  3. Object singletonObject = this.singletonObjects.get(beanName);
  4. if (singletonObject == null && this.isSingletonCurrentlyInCreation(beanName)) {
  5. singletonObject = this.earlySingletonObjects.get(beanName);
  6. if (singletonObject == null && allowEarlyReference) {
  7. synchronized(this.singletonObjects) {
  8. singletonObject = this.singletonObjects.get(beanName);
  9. if (singletonObject == null) {
  10. singletonObject = this.earlySingletonObjects.get(beanName);
  11. if (singletonObject == null) {
  12. ObjectFactory<?> singletonFactory = (ObjectFactory)this.singletonFactories.get(beanName);
  13. if (singletonFactory != null) {
  14. singletonObject = singletonFactory.getObject();
  15. this.earlySingletonObjects.put(beanName, singletonObject);
  16. this.singletonFactories.remove(beanName);
  17. }
  18. }
  19. }
  20. }
  21. }
  22. }
  23. return singletonObject;
  24. }
  1. /**
  2. * Returns the value to which the specified key is mapped,
  3. * or {@code null} if this map contains no mapping for the key.
  4. *
  5. * <p>More formally, if this map contains a mapping from a key
  6. * {@code k} to a value {@code v} such that {@code (key==null ? k==null :
  7. * key.equals(k))}, then this method returns {@code v}; otherwise
  8. * it returns {@code null}. (There can be at most one such mapping.)
  9. *
  10. * <p>If this map permits null values, then a return value of
  11. * {@code null} does not <i>necessarily</i> indicate that the map
  12. * contains no mapping for the key; it's also possible that the map
  13. * explicitly maps the key to {@code null}. The {@link #containsKey
  14. * containsKey} operation may be used to distinguish these two cases.
  15. *
  16. * @param key the key whose associated value is to be returned
  17. * @return the value to which the specified key is mapped, or
  18. * {@code null} if this map contains no mapping for the key
  19. * @throws ClassCastException if the key is of an inappropriate type for
  20. * this map
  21. * (<a href="{@docRoot}/java/util/Collection.html#optional-restrictions">optional</a>)
  22. * @throws NullPointerException if the specified key is null and this map
  23. * does not permit null keys
  24. * (<a href="{@docRoot}/java/util/Collection.html#optional-restrictions">optional</a>)
  25. */
  26. /**
  27. * 如果这个映射包含从密钥k到值v的映射,那么(密钥==null?k==null : key.equals(k)),那么这个方法返回v;否则返回null。(这样的映射最多只能有一个。)
  28. * 如果此映射允许空值,则空返回值不一定表示映射不包含键的映射;也有可能映射将键显式映射为null。
  29. */
  30. V get(Object key);

image.png
image.png

发送邮件接口实现类

  1. package org.jeecg.modules.message.handle.impl;
  2. import org.jeecg.common.util.SpringContextUtils;
  3. import org.jeecg.common.util.oConvertUtils;
  4. import org.jeecg.config.StaticConfig;
  5. import org.jeecg.modules.message.handle.ISendMsgHandle;
  6. import org.springframework.mail.SimpleMailMessage;
  7. import org.springframework.mail.javamail.JavaMailSender;
  8. import org.springframework.mail.javamail.MimeMessageHelper;
  9. import javax.mail.MessagingException;
  10. import javax.mail.internet.MimeMessage;
  11. public class EmailSendMsgHandle implements ISendMsgHandle {
  12. static String emailFrom;
  13. public static void setEmailFrom(String emailFrom) {
  14. EmailSendMsgHandle.emailFrom = emailFrom;
  15. }
  16. @Override
  17. public void SendMsg(String es_receiver, String es_title, String es_content) {
  18. JavaMailSender mailSender = (JavaMailSender) SpringContextUtils.getBean("mailSender");
  19. MimeMessage message = mailSender.createMimeMessage();
  20. MimeMessageHelper helper = null;
  21. //update-begin-author:taoyan date:20200811 for:配置类数据获取
  22. if(oConvertUtils.isEmpty(emailFrom)){
  23. StaticConfig staticConfig = SpringContextUtils.getBean(StaticConfig.class);
  24. setEmailFrom(staticConfig.getEmailFrom());
  25. }
  26. //update-end-author:taoyan date:20200811 for:配置类数据获取
  27. try {
  28. helper = new MimeMessageHelper(message, true);
  29. // 设置发送方邮箱地址
  30. helper.setFrom(emailFrom);
  31. helper.setTo(es_receiver);
  32. helper.setSubject(es_title);
  33. helper.setText(es_content, true);
  34. mailSender.send(message);
  35. } catch (MessagingException e) {
  36. e.printStackTrace();
  37. }
  38. }
  39. }

实际调用的是spring提供的JavaMailSender进行邮件发送

调用邮件发送接口发送邮件

  1. EmailSendMsgHandle emailSendMsgHandle = new EmailSendMsgHandle();
  2. String es_receiver = "rongcw@upcif.com";
  3. String es_title = "jeecg测试邮件";
  4. String es_content = "测试内容"
  5. emailSendMsgHandle.SendMsg(es_receiver ,es_title ,es_content );

发送邮件接口上送参数说明

名称 类型 说明
es_receiver String 接收邮件邮箱
es_title String 邮件标题
es_content String 邮件发送内容

自定义注解禁止重复提交

注解接口类

  1. @Target(ElementType.METHOD)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. @Inherited
  5. public @interface LimitSubmit {
  6. String key() ;
  7. /**
  8. * 默认 10s
  9. */
  10. int limit() default 10;
  11. /**
  12. * 请求完成后 是否一直等待
  13. * true则等待
  14. * @return
  15. */
  16. boolean needAllWait() default true;
  17. }

注解接口实现类

  1. @Component
  2. @Aspect
  3. @Slf4j
  4. public class LimitSubmitAspect {
  5. //封装了redis操作各种方法
  6. @Autowired
  7. private RedisUtil redisUtil;
  8. @Pointcut("@annotation(org.jeecg.common.aspect.annotation.LimitSubmit)")
  9. private void pointcut() {}
  10. @Around("pointcut()")
  11. public Object handleSubmit(ProceedingJoinPoint joinPoint) throws Throwable {
  12. LoginUser sysUser = (LoginUser)SecurityUtils.getSubject().getPrincipal();
  13. Method method = ((MethodSignature) joinPoint.getSignature()).getMethod();
  14. //获取注解信息
  15. LimitSubmit limitSubmit = method.getAnnotation(LimitSubmit.class);
  16. int submitTimeLimiter = limitSubmit.limit();
  17. String redisKey = limitSubmit.key();
  18. boolean needAllWait = limitSubmit.needAllWait();
  19. String key = getRedisKey(sysUser,joinPoint, redisKey);
  20. Object result = redisUtil.get(key);
  21. if (result != null) {
  22. throw new JeecgBootException("请勿重复访问!");
  23. }
  24. redisUtil.set( key, sysUser.getId(),submitTimeLimiter);
  25. try {
  26. Object proceed = joinPoint.proceed();
  27. return proceed;
  28. } catch (Throwable e) {
  29. log.error("Exception in {}.{}() with cause = \'{}\' and exception = \'{}\'", joinPoint.getSignature().getDeclaringTypeName(),
  30. joinPoint.getSignature().getName(), e.getCause() != null? e.getCause() : "NULL", e.getMessage(), e);
  31. throw e;
  32. }finally {
  33. if(!needAllWait) {
  34. redisUtil.del(redisKey);
  35. }
  36. }
  37. }
  38. /**
  39. * 支持多参数,从请求参数进行处理
  40. */
  41. private String getRedisKey(LoginUser sysUser,ProceedingJoinPoint joinPoint ,String key ){
  42. if(key.contains("%s")) {
  43. key = String.format(key, sysUser.getId());
  44. }
  45. Method method = ((MethodSignature) joinPoint.getSignature()).getMethod();
  46. LocalVariableTableParameterNameDiscoverer discoverer = new LocalVariableTableParameterNameDiscoverer();
  47. String[] parameterNames = discoverer.getParameterNames(method);
  48. if (parameterNames != null) {
  49. for (int i=0; i < parameterNames.length; i++ ) {
  50. String item = parameterNames[i];
  51. if(key.contains("#"+item)){
  52. key = key.replace("#"+item, joinPoint.getArgs()[i].toString());
  53. }
  54. }
  55. }
  56. return key.toString();
  57. }
  58. }

注解的使用

在请求接口方法上加入@LimitSubmit(key = “testLimit:%s:#orderId”,limit = 10,needAllWait = true)
testLimit:将存入到redis中的key生成在testLimit文件中
%S:代表当前登录人
#:参数,代表从参数中获取,支持多个参数,生成的redis key:testLimit:e9ca23d68d884d4ebb19d07889727dae:order1123123

1.限制对某个接口的访问,针对所有人 ,则去除%S
2.限制某个人对某个接口的访问,则 %S
3.限制某个人对某个接口的业务参数的访问,则 %S:#参数1:#参数2

注意

写入的参数需包含在请求接口方法接收前端发送的参数中,否则会报空指针异常
#写入的参数可以写多个,用逗号隔开
#写入的参数需是参数名,会自动通过参数名获取参数值

批量插入效率研究建议

验证每种插入方法所消耗的时间
初始化插入数据

  1. public List<JeecgDemo> initDemos(){
  2. List<JeecgDemo> demos = new ArrayList<>();
  3. for (int i = 0; i < 10000; i++) {
  4. JeecgDemo demo = new JeecgDemo();
  5. demo.setSysOrgCode(i+"");
  6. demo.setName(i+"name");
  7. demo.setKeyWord(i+"keyWord");
  8. demo.setPunchTime(new Date());
  9. demo.setSalaryMoney(BigDecimal.ONE);
  10. demo.setBonusMoney(1d);
  11. demo.setSex("1");
  12. demo.setAge(10);
  13. demo.setBirthday(new Date());
  14. demo.setEmail("fad@qq.com");
  15. demo.setContent("fad@qq.com");
  16. demos.add(demo);
  17. }
  18. return demos;
  19. }
  20. public List<Object[]> initJDBCDemos(){
  21. List<Object[]> demos = new ArrayList<>();
  22. for (int i = 0; i < 10000; i++) {
  23. Object[] demo = new Object[11];
  24. demo[0] =i+""+new Date();
  25. demo[1] =i+"name";
  26. demo[2] =i+"keyWord";
  27. demo[3] =new Date();
  28. demo[4] =BigDecimal.ONE;
  29. demo[5] =1d;
  30. demo[6] ="1";
  31. demo[7] =10;
  32. demo[8] =new Date();
  33. demo[9] ="fad@qq.com";
  34. demo[10] ="fad@qq.com";
  35. demos.add(demo);
  36. }
  37. return demos;
  38. }

默认情况下,循环插入

  1. @Test
  2. @Transactional //单元测试中,默认回滚,防止污染数据库表
  3. public void testMybatisInsert100000Save() {
  4. List<JeecgDemo> jeecgDemoList = initDemos();
  5. long start = System.currentTimeMillis();
  6. jeecgDemoList.forEach(jeecgDemo -> {
  7. jeecgDemoMapper.insert(jeecgDemo);
  8. });
  9. long end = System.currentTimeMillis();
  10. System.out.println("默认情况下,循环插入耗时为:"+(end-start));
  11. }

默认情况下,循环插入耗时为:142564

批量保存的情况下插入

  1. @Test
  2. @Transactional
  3. public void testMybatisInsert100000BatchSave() {
  4. List<JeecgDemo> jeecgDemoList = initDemos();
  5. long start = System.currentTimeMillis();
  6. jeecgDemoMapper.insertBatch(jeecgDemoList);
  7. long end = System.currentTimeMillis();
  8. System.out.println("批量保存,插入耗时为:"+(end-start));
  9. }

批量保存,插入耗时为:2489

Mybatis 自带批量保存

  1. @Test
  2. @Transactional
  3. public void testMybatisInsert100000SqlSessionBatchSave() {
  4. List<JeecgDemo> jeecgDemoList = initDemos();
  5. SqlSession sqlSession = sqlSessionTemplate.getSqlSessionFactory().openSession(ExecutorType.BATCH.BATCH, false);
  6. JeecgDemoMapper jeecgDemoMapper = sqlSession.getMapper(JeecgDemoMapper.class);
  7. long start = System.currentTimeMillis();
  8. jeecgDemoList.forEach(jeecgDemo -> {
  9. jeecgDemoMapper.insert(jeecgDemo);
  10. });
  11. sqlSession.commit();
  12. long end = System.currentTimeMillis();
  13. System.out.println("Mybatis 自带批量保存,插入耗时为:"+(end-start));
  14. }

Mybatis 自带批量保存,插入耗时为:69812

SpringJDBC批量保存(此方式最快)

  1. @Test
  2. @Transactional
  3. public void testJdbcInsert100000BatchSave() {
  4. List<Object[]> jeecgDemoList = initJDBCDemos();
  5. DruidDataSource dataSource = DynamicDBUtil.getDbSourceByDbKey("master");
  6. try {
  7. System.out.println(dataSource.getConnection().toString());
  8. }catch (Exception e){
  9. e.printStackTrace();
  10. }
  11. JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
  12. String sql ="INSERT INTO `demo`( `id`, `name`,\n" +
  13. "\t\t`key_word`,\n" +
  14. "\t\t`punch_time`,\n" +
  15. "\t\t `salary_money`,\n" +
  16. "\t\t `bonus_money`,\n" +
  17. "\t\t `sex`, `age`, `birthday`,\n" +
  18. "\t\t `email`, `content`)\n" +
  19. "\t\tVALUES (?,?,?,?,?,?,?,?,?,?,?)";
  20. long start = System.currentTimeMillis();
  21. jdbcTemplate.batchUpdate(sql,jeecgDemoList);
  22. long end = System.currentTimeMillis();
  23. System.out.println(" SpringJDBC批量保存,插入耗时为:"+(end-start));
  24. }

SpringJDBC批量保存,插入耗时为:818
因此可得出结论SpringJDBC批量插入是最快的

接口敏感数据安全

注解方案

敏感数据不允许传递给前端,展示在接口JSON结果中 =>
例如: 用户表的密码和加密盐属于敏感信息,不能在查询用户列表结果JSON中展示,但是平台用的是Mybatis-plus,分页会直接查询全部字段,怎么排除敏感字段呢?
在需要排除的敏感字段的实体属性类上的敏感属性上添加以下注解

  1. @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)

导入的包

  1. import com.fasterxml.jackson.annotation.JsonProperty;

参数说明

value:将trueName属性数序列化为name,即{“name”:””}

  1. @JsonProperty(value="name")
  2. private String trueName;

access:
JsonProperty.Access.WRITE_ONLY 接口请求时该属性忽略,也就是序列化时忽略属性
JsonProperty.Access.READ_ONLY 不受影响,接口接收不存在反序列化操作

积木报表设计器的使用

使用

第一步: 引入JimuReport 依赖

  1. <dependency>
  2. <groupId>org.jeecgframework.jimureport</groupId>
  3. <artifactId>jimureport-spring-boot-starter</artifactId>
  4. <version>1.3.78</version>
  5. </dependency>

最新版本可以从 http://jimureport.com/doc/log 中查询到

第二步:修改配置application.yml

  1. #minidao配置
  2. minidao :
  3. base-package: org.jeecg.modules.jmreport.desreport.dao*
  4. #静态资源加载配置
  5. spring:
  6. mvc:
  7. static-path-pattern: /**
  8. resource:
  9. static-locations: classpath:/static/,classpath:/public/

第三步: 初始化Sql脚本

jimureport.mysql5.7.create.sql

第四步:排除请求拦截

JimuReport自带权限控制,所以需要放开自己框架对JimuReport请求的权限拦截;JeecgBoot修改org.jeecg.config.shiro.ShiroConfig加入以下代码,其他项目参考修改即可。

  1. //积木报表排除
  2. filterChainDefinitionMap.put("/jmreport/**", "anon");

第五步:增加spring扫码路径

  1. @SpringBootApplication(scanBasePackages = {"org.jeecg.modules.jmreport"})

第六步: 访问积木报表

访问地址: {项目前缀}/jmreport/list

设计积木报表

  1. 点击积木报表设计,进入积木报表创建页面

image.png

  1. 选择报表类型,新建报表模板或者现在报表模板,进入报表设计页面

image.png

SQL数据集

  1. 在报表设计页面,在数据集管理中选择SQL数据集

image.png

  1. 需要注意填写的SQL必须是在项目数据库中查询到数据,SQL语句支持参数查询,传递的参数必须符合规范,填写完成后点击右边的SQL解析按钮

image.png

  1. 解析后的动态报表配置明细为SQL查询的实体字段名,报表参数为SQL语句中动态参数,在报表参数中参数和参数文本对应SQL语句中参数 填写默认值后预览可根据默认值展示数据

image.png

  1. 确定保存后退出,进入报表设计页面,选择左边数据集,拖拽到右边Excel表格中

image.png

  1. 保存后预览查看

image.png
image.png

API数据集

  1. 在报表设计页面,在数据集管理中选择api数据集
    事务、定时任务、系统接口通知、消息推送、短信接口、邮箱接口、消息敏感安全、自定义注解重复提交、批量插入效率建议、积木报表 - 图33
  2. 填写编码和名称后选择请求方式,在api地址中填写api的请求地址注意:api请求的参数必须是json格式并json开头为data,后面的数据为json数组或json对象如果没有data直接返回json数组或json对象

事务、定时任务、系统接口通知、消息推送、短信接口、邮箱接口、消息敏感安全、自定义注解重复提交、批量插入效率建议、积木报表 - 图34

  1. api请求的地址支持传递参数,在api地址后拼接参数后,需要在报表参数中手动添加参数以及参数文本和默认值

    填写完成后点击api解析将解析的参数和api参数保存,即可在设计页面根据报表参数设计报表

也可通过导入Excel来设计报表

通过sql数据集来设计一个钻取报表

image.png

建立主表的报表

添加sql数据集

  1. SELECT
  2. b.sn,
  3. a.billing_month,
  4. b.name,
  5. b.party_type,
  6. a.social_security_orders,
  7. a.commision_month,
  8. a.level1_commision_month,
  9. a.level1_commision_orders,
  10. a.level2_commision_month,
  11. a.level2_commision_orders,
  12. a.member_month,
  13. a.member_total,
  14. a.child_num_month,
  15. a.child_num_total
  16. FROM
  17. onekm_merchant_commision a,
  18. mopai_merchant b
  19. WHERE a.party_id = b.id
  20. <#if isNotEmpty(sn)>
  21. and b.sn = '${sn}'
  22. </#if>
  23. <#if isNotEmpty(party_type)>
  24. and b.party_type in (${party_type})
  25. </#if>
  26. <#if isNotEmpty(billing_month)>
  27. and a.billing_month = '${billing_month}'
  28. </#if>
  29. ORDER BY a.billing_month DESC

<#if isNotEmpty(sn)> and b.sn = ‘${sn}’</#if>,可以为我们提供动态传参,通过isNotEmpty方法判断传入的参数是否为空,是则为true,会在sql语句中拼接标签中的参数语句。
解析之前需要设计数据源,否则可能因为找不到表而报错,默认使用的数据源是在配置文件中已经配置好了的,如果需要其他数据源名,需根据下图点击对应的图标来添加数据源
image.png
然后
image.png
最后填写数据源相关的信息,填写完成之后可以点击测试是否能成功连接数据库,测试成功后点击确认保存,然后通过下拉单选选择对应的数据源就可以了
image.png
sql数据集的一些配置
image.png
设置查询条件,有两种方式,一种是通过报表字段明细,另一种是通过报表参数
报表字段明细:
image.png
成功解析sql后会自动出现。可勾选查询框,勾选后可作为查询条件进行查询,勾选查询后,可在对应的字段选择查询模式,例如下拉单选、下拉多选、输入等,如果是时间格式的查询条件,可通过查询日期格式来设置输入的时间格式,比如yyyy-MM,代表2021-10。
该设置的缺点是通过拼接sql语句来设置查询条件的,查询效率低,所以推荐使用报表参数来设置查询条件。

报表参数:
需要在sql语句中事先定义好where查询条件,字符串格式的参数设置为:’${参数}’,不是字符串的可以不用单引号
image.png
也是成功解析后才会出现,一样的可以设置是否是查询,查询默认,添加默认值等

设置好后点击确认保存即可,也可事先在数据预览中查看是否有相关的数据,如果是设置了报表参数,预览没有数据,这个不用担心,因为没有传值进去,参数都是空的,除非设置了默认值或者表中有记录,但对应的参数本事就是空的
设置好报表格式后,可点击数据集对应的字段拖拽到报表中
image.png
预览效果
image.png

建立钻取子表

添加钻取链接

首先在主表设计页面中添加钻取链接,如下图
image.png
然后填写相关信息
image.png
链接报表需要事先添加字表报表
弹出方式可页内,也可页外
参数设置即为点击跳转后需要传的参数,=A意思是该行的A列的值
最后点击确认即可

添加字表数据集

一样的跟主表一样需先选择数据源,默认不选即为配置文件中配置的数据源

  1. SELECT c.`name`, a.`month_orders`, a.`reuse_orders_month`, a.`orders_total`, a.`commision_month`, a.`level1_commision_month`, a.`level1_commision_orders`, a.`level2_commision_month`, a.`level2_commision_orders` FROM `onekm_commision_detail` a, `mopai_merchant` b, `mopai_service` c WHERE a.`party_id` = b.`id` AND a.`service` = c.`id` AND b.`sn` = '${sn}' AND a.`billing_month` = '${billing_month}' ORDER BY c.`orders` ASC

子表必须要设置报表参数,因为我们需要接收主表传入的参数,所以sql语句需要写where条件
image.png
解析成功后点击确认保存即可
也是一样拖住字段设计报表格式,最后点击保存即可
image.png
然后在主表设计页面中点击预览,然后点击详情即可跳转到子表
image.png

设置字典表

在需要设置下拉单选或者下拉多选的时候常常需要用到字典表,在报表设计主页面可点击下图所示箭头的图标来添加字典表
image.png
image.png
添加后点击字典配置添加字段
image.png
名称为添加的字段名,数据值为字段的参数值,排序根据大小来排序,小的在前面,最后点击启用,保存就可以了
image.png
然后在报表字段明细或者报表参数中的字典code添加响应的字典code,就会在查询条件中显示想要的字段

给查询条件动态传值

通过添加js增强代码来给查询条件传默认值
在报表设计页面中点击其他设置,添加增强配置
image.png
选择JS,添加相关代码
image.png
该配置只能定义一个function方法,且方法名必须为init
然后通过this.updateSearchFormValue(‘ts0001’, ‘billing_month’,result);来设置默认值,第一个参数为添加数据集时设置的编码image.png,第二个参数为需要添加值的字段名,第三个参数为需要传入的值,最后点击确认保存即可
效果:
image.png

设置js带来的问题

  1. 在设计钻取报表如果是业内跳转,且需要传入值的参数名跟js需要设置参数的值的名一样的话,会把js设置的之传入字表中,造成字表查询的记录与原本的需求相悖

解决方案:在子表报表中设置不一样的参数,即a.billing_month = ‘${billing_month1}’,然后在主表报表中的连接参数配置中image.png修改对应的参数名就可

  1. 如果js传入的值查询后没有记录,预览的时候分页将会失效,只有当js传入的值能够查询到记录,分页才不会失效,目前已反馈给官方,已经解决,预计在下个版本中修复

    通过sql数据集来设计一个条形图

    添加sql数据集,一样的先选择数据源,然后添加相关信息,解析成功后点击确认保存即可
    image.png
    1. SELECT
    2. DATE_FORMAT( a.`create_date`, '%Y%m%d' ) AS create_date,
    3. COUNT(*) AS total,
    4. '订单总数' AS type
    5. FROM
    6. mopai_order a
    7. WHERE
    8. a.`create_date` >= '2021-07-21'
    9. AND a.`payment_date` >= '2021-07-21'
    10. AND a.`create_date` <= '2021-10-21 23:59:59'
    11. AND a.`payment_date` <= '2021-10-21 23:59:59'
    12. AND a.`order_status` NOT IN ( 6, 8 )
    13. AND a.`payment_status` IN ( 2, 3 )
    14. GROUP BY
    15. DATE_FORMAT( a.`create_date`, '%Y%m%d' ) UNION
    16. SELECT
    17. DATE_FORMAT( c.`create_date`, '%Y%m%d' ) AS create_date,
    18. COUNT(*) AS total,
    19. '跑兔总数' AS type
    20. FROM
    21. mopai_merchant c
    22. WHERE
    23. c.`create_date` >= '2021-07-21'
    24. AND c.`create_date` <= '2021-10-21 23:59:59'
    25. AND c.`audit_status` = 1
    26. AND c.`party_type` = 12
    27. GROUP BY
    28. DATE_FORMAT( c.`create_date`, '%Y%m%d' ) UNION
    29. SELECT
    30. DATE_FORMAT( b.`create_date`, '%Y%m%d' ) AS create_date,
    31. COUNT(*) AS total,
    32. '会员总数' AS type
    33. FROM
    34. mopai_member b
    35. WHERE
    36. b.`create_date` >= '2021-07-21'
    37. AND b.`create_date` <= '2021-10-21 23:59:59'
    38. AND b.`is_locked` = 0
    39. AND b.`is_enabled` = 1
    40. GROUP BY
    41. DATE_FORMAT( b.`create_date`, '%Y%m%d' ) ORDER BY create_date DESC
    这里需要注意的是,积木报表规定必须有三个字段,且字段对应的值也有规定,比如
    image.png
    这里的字段名和值无规定,只需要格式满足就可以了

添加图形报表,选好后点击确认即可,可将其拖住到相应位置,或者调整大小
image.png
添加后,设置相关数据,选择对应的字段
image.png

  • 绑定数据集:是左侧绑定过的数据集,可选择任意一个SQL类型的数据集;
  • 分类属性:是X轴绑定数据库的字段;
  • 值属性:是Y轴绑定数据库的字段;
  • 系列属性:对应的是线的类型;

可定时刷新,最后点击运行即可
效果图
image.png
也可选择其他图形报表进行设计,步骤也是一样的

菜单路由报表

即在菜单页面中显示报表
第一步 需要在报表设计页面中点击预览查看预览页地址栏,然后记下红色框中选中的
image.png
第二步 在首页中系统管理中的菜单管理添加菜单
image.png
添加一级菜单,其中菜单名称和菜单路径可以自定义,不过菜单路径需是/开头,前端组件固定为layouts/RouteView
image.png
添加一级菜单后,点击更多添加二级菜单
image.png
配置二级菜单,主要是菜单路径{{ window._CONFIG[‘domianURL’] }}是项目路径,固定器,然后尾部是预览页中已经记下的路径地址
image.png
保存后,需在角色管理中授权
image.png
最后重新刷新页面
效果
image.png

其他相关配置

image.png
http://report.jeecg.com/2078898

积木报表和online报表是否通用

积木报表没有设计表单功能

online表单可以对接积木报表,目前遇到的问题是,在积木报表中配置online表单,通过API访问报错
报错信息:{“success”:false,”message”:”操作失败,Name for argument of type [java.lang.String] not specified, and parameter name information not found in class file either.”,”code”:500,”result”:null,”timestamp”:1634267793424}
目前官方已经解决,预计将会在下个版本中修复
通过online配置积木报表的表单,添加了对某条数据的打印功能,需现在积木报表中配置了对应表的online表单,然后通过打印,将选中的某条记录的值传过去
详情可看:http://doc.jeecg.com/2373083

积木报表应用场景

1.可通过报表来设计查询表
2.可导入Excel文件进行报表设计
3.可将报表导出excel、pdf等文件
4.可通过配置菜单来查询已设计好的报表
5.可设计各种类型的单据、大屏,如出入库单、销售单、财务报表、合同、监控大屏、旅游数据大屏等
6.打印各种数据单