SpringBoot derby springboot derby数据库备份

SpringBoot备份mysql数据库

• 备份

• 备份接口
• 备份方法
• 测试
• 遇到的问题

• 还原
• 列出目前所有的备份
• 删除备份
• 总结

项目开发接近deadline了，打算把数据库的备份做一下，能够让管理员在网页上直接进行数据库的备份、还原等操作。

备份

备份接口

// 备份
    @PreAuthorize("@permission.CheckUser() == 1")
    @PostMapping("/backup/{name}")
    public ResponseEntity backup(@PathVariable("name") String name,
                                 HttpServletRequest request,
                                 HttpServletResponse response){
        backupService.backup(name,request,response);
        return new ResponseEntity(HttpStatus.CREATED);
    }

这里的name是前端传来的文件名

备份方法

@Override
    public ResponseResult backup(String name, HttpServletRequest request, HttpServletResponse response){
        log.info("开始进行数据库备份******************************");
        Admin admin = adminService.checkAdmin(request,response);
        if(admin == null || admin.getAdminId() == null){
            log.info("没有登陆");
            return ResponseResult.ACCOUNT_NOT_LOGIN();
        }
        String host = BackupConstants.HOST;
        String userName = BackupConstants.USER_NAME;
        String password = BackupConstants.PASSWORD;
        String database = BackupConstants.DATABASE;
        String backupFolderPath = BackupConstants.BACKUP_FOLDER + name + File.separator;
        String fileName = name;
        log.info("校验成功，开始进行备份");
        try {
            boolean success = MySqlBackupRestoreUtils.backup(host, userName, password, backupFolderPath, fileName, database);
            if(!success) {
                log.info("数据备份失败");
                return ResponseResult.FAILED("备份失败!");
            }
        } catch (Exception e) {
            System.out.println(e);
        }
        log.info("备份成功！文件存储在:  "+backupFolderPath+fileName);
        return ResponseResult.SUCCESS("备份成功！文件存储在:  "+backupFolderPath+fileName+".sql");
    }

这里主要是进行一些准备工作，包括数据库url、账户、密码、存储路径等信息的设置，然后会进入一个
MySqlBackupRestoreUtils.backup方法

/**
     * 备份数据库
     * @param host host地址，可以是本机也可以是远程
     * @param userName 数据库的用户名
     * @param password 数据库的密码
     * @param backupFolderPath 备份的路径
     * @param fileName 备份的文件名
     * @param database 需要备份的数据库的名称
     * @return
     * @throws IOException
     */
    public static boolean backup(String host, String userName, String password, String backupFolderPath, String fileName,
                                 String database) throws Exception {
        File backupFolderFile = new File(backupFolderPath);
        if (!backupFolderFile.exists()) {
            // 如果目录不存在则创建
            backupFolderFile.mkdirs();
        }
        if (!backupFolderPath.endsWith(File.separator) && !backupFolderPath.endsWith("/")) {
            backupFolderPath = backupFolderPath + File.separator;
        }
        String backupFilePath = backupFolderPath + fileName;
//        System.out.println(stringBuilder.toString());
        // 调用外部执行 exe 文件的 Java API

        try {
            Runtime rt = Runtime.getRuntime();

            // 调用 调用mysql的安装目录的命令
            Process child = rt.exec("mysqldump -h "+host+" -u"+userName+" -p"+password+" db_aram");
            InputStream in = child.getInputStream();

            InputStreamReader xx = new InputStreamReader(in, "utf-8");

            String inStr;
            StringBuffer sb = new StringBuffer("");
            String outStr;
            // 组合控制台输出信息字符串
            BufferedReader br = new BufferedReader(xx);
            while ((inStr = br.readLine()) != null) {
                sb.append(inStr + "\r\n");
            }
            outStr = sb.toString();

            // 要用来做导入用的sql目标文件：
            FileOutputStream fout = new FileOutputStream(backupFilePath+".sql");
            OutputStreamWriter writer = new OutputStreamWriter(fout, "utf-8");
            writer.write(outStr);
            writer.flush();
            in.close();
            xx.close();
            br.close();
            writer.close();
            fout.close();
            System.out.println("");

        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
        return true;

主要技术点就是利用java调取控制台，在控制台运行mysqldump命令进行数据库的备份，然后会在控制台获取输出流，把进程执行中的控制台输出信息写入.sql文件，即生成了备份文件。这里如果不对控制台信息进行读出，则会导致进程堵塞无法运行。然后把信息写入到sql中，最后关闭输入输出流，获得文件。

测试

点击excute后，IDEA控制台信息：

然后是文件保存地址

图中的.sql文件就是我们获取到的备份文件。打开后如图

备份成功。

遇到的问题

最初在控制台运行mysqldump时提示找不到命令，思考后发现我本地是没有安装mysql数据库的，只在服务器安装了。因此又在我的电脑安装了mysql 5.7版本，然后配置好环境变量，把安装目录下的bin路径添加到系统变量path中，才能在控制台直接使用mysqldump方法。

还原

/**
     * 还原数据库
     * @param restoreFilePath 数据库备份的脚本路径
     * @param host IP地址
     * @param database 数据库名称
     * @param userName 用户名
     * @param password 密码
     * @return
     */
    public static boolean restore(String restoreFilePath, String host, String userName, String password, String database) throws Exception {
        File restoreFile = new File(restoreFilePath);
        if (restoreFile.isDirectory()) {
            for (File file : restoreFile.listFiles()) {
                if (file.exists() && file.getPath().endsWith(".sql")) {
                    restoreFilePath = file.getAbsolutePath();
                    break;
                }
            }
        }

        try {
            Runtime runtime = Runtime.getRuntime();
            Process process = runtime
                    .exec("mysql.exe -h"+host+" -u"+userName+" -p"+password+" --default-character-set=utf8 " + database);
            OutputStream outputStream = process.getOutputStream();
            BufferedReader br = new BufferedReader(new InputStreamReader(new FileInputStream(restoreFilePath), "utf-8"));
            String str = null;
            StringBuffer sb = new StringBuffer();
            while ((str = br.readLine()) != null) {
                sb.append(str + "\r\n");
            }
            str = sb.toString();
            // System.out.println(str);
            OutputStreamWriter writer = new OutputStreamWriter(outputStream, "utf-8");
            writer.write(str);
            writer.flush();
            outputStream.close();
            br.close();
            writer.close();
            log.info("数据已从 " + restoreFilePath + " 导入到数据库中");
            return true;
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
            log.info("数据从 " + restoreFilePath + " 导入到数据库失败");
        } catch (FileNotFoundException e) {
            e.printStackTrace();
            log.info("数据从 " + restoreFilePath + " 导入到数据库失败");
        } catch (IOException e) {
            e.printStackTrace();
            log.info("数据从 " + restoreFilePath + " 导入到数据库失败");
        }
        return false;
    }

还原过程和备份过程，大体是相反的过程，从sql文件中获得输出流到控制台，然后通过命令mysql.exe存入到数据库中。但是在开始运行时出现了如下错误

管道已关闭，初步猜想可能是文件编码问题导致读出数据是乱码，于是加上log.info(str)，看看输出流里面的内容

看来是可以正常读取数据的，那问题可能出在写入流，可能是权限不足？查阅资料后给用户加了权限，并在命令行直接输入命令测试通过后，再次测试接口，恢复成功。

列出目前所有的备份

实现代码

@Override
    public List<Map<String, String>> queryBackup(HttpServletRequest request, HttpServletResponse response){
        List<Map<String, String>> backupRecords = new ArrayList<>();
        File restoreFolderFile = new File(BackupConstants.RESTORE_FOLDER);
        if(restoreFolderFile.exists()) {
            for(File file:restoreFolderFile.listFiles()) {
                Map<String, String> backup = new HashMap<>();
                backup.put("title", file.getName());
                backupRecords.add(backup);
            }
        }
        // 按时间戳排序，新备份在前面
        backupRecords.sort((o1, o2) -> o2.get("title").compareTo(o1.get("title")));
        return backupRecords;
    }

大体就是从一个固定的目录中读取文件，然后添加到一个List<Map<String,Object>>中，按时间排序后再返回给管理员一个列表，这样管理员就可以根据名字进行恢复或者删除操作。

删除备份

@Override
    public void delBackup(String name){
        String restoreFilePath = BackupConstants.BACKUP_FOLDER + name;
        try {
            FileUtil.deleteFile(new File(restoreFilePath));
        } catch (Exception e) {
            System.out.println(e);
        }
    }

接收前端传来的文件名，然后根据文件名删除文件。

总结

关于数据库的备份恢复其实主要还是通过io流来实现，因为刚开始对这部分知识不是很熟悉，因此出了不少错误。好在最后算是成功解决了，实现了备份恢复功能。感觉javaIO流的功能太强大了，值得深入研究学习。