Spring boot 集成 ureport （三） 报表存储至数据库

声明：代码为核心代码，为了简洁！完整代码请移步我的github -->【带我传送到github】

UReport2默认提供的名为“服务器文件系统”的报表存储机制，实际上是实现了UReport2提供的com.bstek.ureport.provider.report.ReportProvider接口;如果我们定义了自己的报表存储器，只需要实现了ReportProvider接口后，并将实现类配置到Spring中，让其成为一个标准的Spring Bean，这样UReport2就会检测到它而将其加载。

如果你不想将报表文件存储到默认的路径下，而是数据库中，那么下面的代码可以解决你得问题！

技术选型：

    1、项目持久层采用轻量级框架 MyBatis

     2、使用mysql 做存储源

DB设计：

字段名	类型	描述
id_	int primary key	主键
name_	varchar(100)	报表名称
content_	mediumblob	报表内容
create_time_	timestamp	创建时间
update_time_	timestamp	更新时间

/** 建表 sql */
create table ureport_file_tbl ( 
 id_ int primary key auto_increment, 
  name_ varchar(100) not null,
  content_ mediumblob,
  create_time_ timestamp default now(),
  update_time_ timestamp default now()
) 

代码部分：

pom.xml

<!-- MyBatis 启动器 -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.3.1</version>
</dependency>
<!-- mysql驱动  -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- 消除冗余代码,可以省去get、set、构造器... 方法 -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <scope>provided</scope>
</dependency>

application.yml

# MyBatis  
mybatis:  
    typeAliasesPackage: indi.qiaolin.test.ureport.entity
    mapperLocations: classpath:/indi/qiaolin/**/mapper/*.xml  
  
# 日志配置
logging:
  level:
    org.apache.ibatis: DEBUG

# ureport Mysql 存储
ureport.mysql.provider:
  prefix: qiaolin-
  disabled: false

实体类：

package indi.qiaolin.test.ureport.entity;

import java.util.Date;
import lombok.Data;

/**
 *  Ureport文件 实体类
 * @author qiaolin
 * @version 2018年5月9日
 *
 */

@Data
public class UreportFileEntity {
	
	private Long id;
	private String name;
	private byte[] content;
	private Date createTime;
	private Date updateTime;
	
}

Mapper接口：

package indi.qiaolin.test.ureport.mapper;

import java.util.List;
import org.apache.ibatis.annotations.Mapper;
import indi.qiaolin.test.ureport.entity.UreportFileEntity;

/**
 *  Ureport文件 Mapper
 * @author qiaolin
 * @version 2018年5月9日
 *
 */

@Mapper
public interface UreportFileMapper {
	
	/**
	 *  根据报表名称检查报表是否存在
	 * @param name 报表名称
	 * @return
	 */
	public int checkExistByName(String name);
	
	/**
	 *  根据报表名称查询报表
	 * @param name 报表名称
	 * @return
	 */
	public UreportFileEntity queryUreportFileEntityByName(String name);
	
	/**
	 * 查询全部报表
	 * @return 
	 */
	public List<UreportFileEntity> queryReportFileList();
	
	/**
	 * 根据报表名称删除报表
	 * @param name
	 * @return
	 */
	public int deleteReportFileByName(String name);
	
	
	/**
	 *  保存报表
	 */
	public int insertReportFile(UreportFileEntity entity);
	
	/**
	 *  更新报表
	 * @param entity
	 * @return
	 */
	public int updateReportFile(UreportFileEntity entity);
}

Mapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="indi.qiaolin.test.ureport.mapper.UreportFileMapper"> 

	<resultMap type="UreportFileEntity" id="ureportFile">
		<id column="id_" jdbcType="BIGINT" property="id"/>
		<result column="name_" jdbcType="VARCHAR" property="name"/>
		<result column="content_" jdbcType="BLOB" property="content"/>
		<result column="create_time_" jdbcType="TIMESTAMP" property="createTime"/>
		<result column="update_time_" jdbcType="TIMESTAMP" property="updateTime"/>
	</resultMap>

	<select id="checkExistByName" parameterType="java.lang.String" resultType="java.lang.Integer">
		select count(*) from ureport_file_tbl where name_ = #{name} 
	</select>
	
	<select id="queryReportFileList" resultMap="ureportFile">
		select * from ureport_file_tbl
	</select>
	
	<select id="queryUreportFileEntityByName" resultMap="ureportFile">
		select * from ureport_file_tbl where name_ = #{name}
	</select>

	<delete id="deleteReportFileByName" parameterType="java.lang.String">
		delete from ureport_file_tbl where name_ = #{name}
	</delete>

	<insert id="insertReportFile" parameterType="UreportFileEntity">
		insert into ureport_file_tbl (name_, content_, create_time_, update_time_) values
		 (#{name}, #{content}, #{createTime}, #{updateTime})
	</insert>


	<update id="updateReportFile" parameterType="UreportFileEntity">
		update ureport_file_tbl set 
			name_ = #{name} , 
			content_ = #{content}, 
			create_time_ = #{createTime}, 
			update_time_ = #{updateTime}
		    where  id_ = #{id}
	</update>

</mapper> 

 最后，Ureport存储

 

自定义报表存储器

       

package indi.qiaolin.test.ureport.provider;

import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import com.bstek.ureport.provider.report.ReportFile;
import com.bstek.ureport.provider.report.ReportProvider;

import indi.qiaolin.test.ureport.entity.UreportFileEntity;
import indi.qiaolin.test.ureport.mapper.UreportFileMapper;
import lombok.Setter;

/**
 * Mysql 报表存储
 * @author qiaolin
 * @version 2018年5月9日
 *
 */

@Setter
@Component
// 该注解可以利用其 prefix属性值 + 类的属性名 在yml中配置属性值
@ConfigurationProperties(prefix = "ureport.mysql.provider") 
public class MySQLProvider implements ReportProvider{
	private static final String NAME = "mysql-provider";
	
        // 特定前缀，ureport底层会调用 getPrefix 方法来获取报表操作的Provier类
	private String prefix = "mysql:";
	
        // 是否禁用
	private boolean disabled; 
	
	@Autowired
	private UreportFileMapper ureportFileMapper;
	
	@Override
	public InputStream loadReport(String file) {
		UreportFileEntity ureportFileEntity = ureportFileMapper.queryUreportFileEntityByName(getCorrectName(file));
		byte[] content = ureportFileEntity.getContent();
		ByteArrayInputStream inputStream = new ByteArrayInputStream(content);
		return inputStream;
	}

	@Override
	public void deleteReport(String file) {
		ureportFileMapper.deleteReportFileByName(getCorrectName(file));
	}

	@Override
	public List<ReportFile> getReportFiles() {
		List<UreportFileEntity> list = ureportFileMapper.queryReportFileList();
		List<ReportFile> reportList = new ArrayList<>();
		for (UreportFileEntity ureportFileEntity : list) {
			reportList.add(new ReportFile(ureportFileEntity.getName(), ureportFileEntity.getUpdateTime()));
		}
		return reportList	;
	}

	@Override
	public void saveReport(String file, String content) {
		file = getCorrectName(file);
		UreportFileEntity ureportFileEntity = ureportFileMapper.queryUreportFileEntityByName(file);
		Date currentDate = new Date();
		if(ureportFileEntity == null){
			ureportFileEntity = new UreportFileEntity();
			ureportFileEntity.setName(file);
			ureportFileEntity.setContent(content.getBytes());
			ureportFileEntity.setCreateTime(currentDate);
			ureportFileEntity.setUpdateTime(currentDate);
			ureportFileMapper.insertReportFile(ureportFileEntity);
		}else{
			ureportFileEntity.setContent(content.getBytes());
   			ureportFileEntity.setUpdateTime(currentDate);
			ureportFileMapper.updateReportFile(ureportFileEntity);
		}
	}

	@Override
	public String getName() {
		return NAME;
	}

	@Override
	public boolean disabled() {
		return disabled;
	}

	@Override
	public String getPrefix() {
		return prefix;
	}

	/**
	 * 获取没有前缀的文件名
	 * @param name
	 * @return
	 */
	private String getCorrectName(String name){
		if(name.startsWith(prefix)){
			name = name.substring(prefix.length(), name.length());
		}
		return name; 
	}
}

做完这些工作，启动程序！即可看到效果，此时已可以保存、修改、获取列表、打开等报表操作！