springboot环境下如何获取web项目根目录并将其作为存放文件日志等的根目录(针对jar包型web工程)

springboot的web项目(jar)默认会在../tmp/...目录作为web的根目录, 这个时候, 若涉及到上传文件问题, 传统做法, 会将文件上传到web根目录的下的某个位置, 但是springboot下, 这样显然非常危险 因为默认的web根目录只是临时的临时的临时的.

这个时候, 我想要的是, 将工程jar包所在目录作为存放文件, 日志等等的根目录.

为了方便, 封装方法:

[[模板方法]]

getJarRootPath()

    private String getJarRootPath() throws FileNotFoundException {
        String path = ResourceUtils.getURL("classpath:").getPath();
        //=> file:/root/tmp/demo-springboot-0.0.1-SNAPSHOT.jar!/BOOT-INF/classes!/
        log.debug("ResourceUtils.getURL(\"classpath:\").getPath() -> "+path);
        //创建File时会自动处理前缀和jar包路径问题  => /root/tmp
        File rootFile = new File(path);
        if(!rootFile.exists()) {
            log.info("根目录不存在, 重新创建");
            rootFile = new File("");
            log.info("重新创建的根目录: "+rootFile.getAbsolutePath());
        }
        log.debug("项目根目录: "+rootFile.getAbsolutePath());        //获取的字符串末尾没有分隔符 /
        return rootFile.getAbsolutePath();
    }

应用: 文件上传


/**
 * 1 文件上传
 * 2 如何获取jar包所在目录, 加工文件上传至改目录下的某个位置.
 */
@WebServlet(urlPatterns = {"/upload/*"})      //springboot配置servlet配置方法之一
public class UploadHandleServlet extends HttpServlet {

    private final Logger log = LoggerFactory.getLogger(UploadHandleServlet.class);
    private final String separator = File.separator;

    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        //得到上传文件的保存目录,将上传的文件存放于WEB-INF目录下,不允许外界直接访问,保证上传文件的安全
//        String savePath = this.getServletContext().getRealPath("/WEB-INF/upload");
        //springboot环境下, 以jar包(项目根目录)所在目录作为文件资料的根目录, 这里定义 data/upload 作为文件上传的存放路径
        //!jar包运行时, 这里有 file: 前缀!
        //String savePath = rootFile.getAbsolutePath() + "data/upload";       //不要直接拼接路径  避免 分隔符多或少
        File savePath = new File(getJarRootPath(), "data/upload");
        //判断上传文件的保存目录是否存在
        if (!savePath.exists() && !savePath.isDirectory()) {
            log.info(savePath + "目录不存在,需要创建");
            //创建目录
            boolean created = savePath.mkdirs();
            if (!created) {
                log.error("路径: '" + savePath.getAbsolutePath() + "'创建失败");
                throw new RuntimeException("路径: '" + savePath.getAbsolutePath() + "'创建失败");
            }
        }
        log.info("文件上传的存储路径为: {}", savePath.getAbsolutePath());
        //消息提示
        String message = "";
        try {
            //使用Apache文件上传组件处理文件上传步骤:
            //1、创建一个DiskFileItemFactory工厂
            DiskFileItemFactory factory = new DiskFileItemFactory();
            //2、创建一个文件上传解析器
            ServletFileUpload upload = new ServletFileUpload(factory);
            //解决上传文件名的中文乱码
            upload.setHeaderEncoding("UTF-8");
            //3、判断提交上来的数据是否是上传表单的数据
            if (!ServletFileUpload.isMultipartContent(request)) {
                //按照传统方式获取数据
                return;
            }
            //4、使用ServletFileUpload解析器解析上传数据,解析结果返回的是一个List集合,每一个FileItem对应一个Form表单的输入项
            List list = upload.parseRequest(request);
            for (FileItem item : list) {
                //如果fileitem中封装的是普通输入项的数据
                if (item.isFormField()) {
                    String name = item.getFieldName();
                    //解决普通输入项的数据的中文乱码问题
                    String value = item.getString("UTF-8");
                    //value = new String(value.getBytes("iso8859-1"),"UTF-8");
                    log.debug(name + "=" + value);
                } else {//如果fileitem中封装的是上传文件
                    //得到上传的文件名称,
                    String filename = item.getName();
                    log.debug(filename);
                    if (filename == null || filename.trim().equals("")) {
                        continue;
                    }
                    //注意:不同的浏览器提交的文件名是不一样的,有些浏览器提交上来的文件名是带有路径的,如:  c:\a\b\1.txt,而有些只是单纯的文件名,如:1.txt
                    //处理获取到的上传文件的文件名的路径部分,只保留文件名部分
                    filename = filename.substring(filename.lastIndexOf("\\") + 1);      //TODO 不同系统下的浏览器提交的文件分隔符不一样
                    //获取item中的上传文件的输入流
                    InputStream in = item.getInputStream();
                    //创建一个文件输出流
                    FileOutputStream out = new FileOutputStream(savePath + separator + filename);
                    //创建一个缓冲区
                    byte buffer[] = new byte[1024];
                    //判断输入流中的数据是否已经读完的标识
                    int len = 0;
                    //循环将输入流读入到缓冲区当中,(len=in.read(buffer))>0就表示in里面还有数据
                    while ((len = in.read(buffer)) > 0) {
                        //使用FileOutputStream输出流将缓冲区的数据写入到指定的目录(savePath + "\\" + filename)当中
                        out.write(buffer, 0, len);
                    }
                    //关闭输入流
                    in.close();
                    //关闭输出流
                    out.close();
                    //删除处理文件上传时生成的临时文件
                    item.delete();
                    message = "文件上传成功!";
                    log.info(message);
                }
            }
        } catch (Exception e) {
            message = "文件上传失败!";
            e.printStackTrace();

        }

//        response.setCharacterEncoding("UTF-8");
//        response.setContentType("html/text;charset=utf-8");
        response.sendRedirect("/message.html");
//        response.getWriter().write(message);


//        request.setAttribute("message",message);
//        request.getRequestDispatcher("/index.html").forward(request, response);
    }

    private String getJarRootPath() throws FileNotFoundException {
        String path = ResourceUtils.getURL("classpath:").getPath();
        //=> file:/root/tmp/demo-springboot-0.0.1-SNAPSHOT.jar!/BOOT-INF/classes!/
        log.debug("ResourceUtils.getURL(\"classpath:\").getPath() -> "+path);
        //创建File时会自动处理前缀和jar包路径问题  => /root/tmp
        File rootFile = new File(path);
        if(!rootFile.exists()) {
            log.info("根目录不存在, 重新创建");
            rootFile = new File("");
            log.info("重新创建的根目录: "+rootFile.getAbsolutePath());
        }
        log.debug("项目根目录: "+rootFile.getAbsolutePath());        //获取的字符串末尾没有分隔符 /
        return rootFile.getAbsolutePath();
    }

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        doGet(request, response);
    }
}

你可能感兴趣的:(springboot环境下如何获取web项目根目录并将其作为存放文件日志等的根目录(针对jar包型web工程))