SpringBoot設置靜態資源訪問控制和封裝集成方案
背景
最近在著手公司框架優化及項目實際應用,原先方案是springboot+html前後端分離單獨部署,後端人員兼職前端開發,後續產品線業務進行優化,面向企業使用部分由移動網站人員負責設計開發,內部配置後臺管理還是由後端負責,隨著框架不停迭代與使用的項目越來越多,項目升級框架變得十分麻煩,後端部分可以通過maven私服進行版本迭代,後臺管理頁面升級則需要進行各個項目拷貝,所以決定對框架進行整合,將後臺管理頁面與框架後端代碼進行整合發佈。
結構設計
- 框架打包後臺管理相關標準資源及頁面(框架public文件夾)
- 項目使用框架,開發具體業務配置管理頁面(項目static文件夾)
- 項目需要個性化框架頁面時,在項目static文件夾建立與框架同目錄同名稱資源文件進行覆蓋,訪問時優先級高於框架目錄
SpringBoot靜態資源訪問
自定義訪問路徑
自定義WebConfig實現WebMvcConfigurer,重寫addResourceHandlers方法
@Configuration public class WebConfig implements WebMvcConfigurer { @Value("${system.projectName}") private String projectName; /** * 添加靜態資源文件,外部可以直接訪問地址 * * @param registry */ @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { //第一個方法設置訪問路徑前綴,第二個方法設置資源路徑 registry.addResourceHandler("/" + projectName + "/**").addResourceLocations("classpath:/static/","classpath:/public/","file:static/"); } }
圖標與字體文件夾訪問失敗問題
將靜態文件拷貝到static/public/resource文件夾下訪問時,圖標與字體文件會進行過濾導致損壞,需要在pom文件中進行設置
<build> <resources> <resource> <filtering>true</filtering> <directory>src/main/resources</directory> <excludes> <exclude>**/*.woff</exclude> <exclude>**/*.ttf</exclude> <exclude>**/*.ico</exclude> </excludes> </resource> <resource> <filtering>false</filtering> <directory>src/main/resources</directory> <includes> <include>**/*.woff</include> <include>**/*.ttf</include> <include>**/*.ico</include> </includes> </resource> </resources> </build>
自定義歡迎頁面
在對靜態內目錄設置自定義訪問路徑替換原有的/**後,無法找到目錄下的index頁面,需要建立攔截器手動進行判斷,效果為訪問http://localhost:port/projectName 會自動跳轉到 http://localhost:port/projectName/index.html
@Component public class PageRedirectInterceptor implements HandlerInterceptor { @Value("${system.projectName}") private String projectName; @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { String requestURL = request.getRequestURL().toString(); String scheme = request.getScheme(); String servaerName = request.getServerName(); int port = request.getServerPort(); String rootPageURL = scheme + ":" + "//" + servaerName + ":" + port + "/" + projectName; if (requestURL.equals(rootPageURL)) { response.sendRedirect(request.getContextPath() + "/"+projectName + "/index.html"); return false; } return true; } }
自定義頁面圖標
在對靜態內目錄設置自定義訪問路徑替換原有的/**後,無法找到目錄下的favcion.ico圖標,需要在頁面引用統一js統一設置,同時需要在配置文件中關閉默認圖標,替換spring的小葉子
spring: mvc: favicon: enabled: false function GetRootPath() { var loc = window.location, host = loc.hostname, protocol = loc.protocol, port = loc.port ? (':' + loc.port) : ''; var path = location.pathname; if (path.indexOf('/') === 0) { path = path.substring(1); } var mypath = '/' + path.split('/')[0]; path = (mypath != undefined ? mypath : ('/' + loc.pathname.split('/')[1])) + '/'; var rootPath = protocol + '//' + host + port + path; return rootPath; } var iconurl = GetRootPath()+"favicon.ico" document.write('<link rel="shortcut icon" href= ' + iconurl + ' ></link>');
項目訪問框架靜態資源
框架靜態資源文件獲取
項目啟動時,因為是引用框架的jar包,我們需要先找到指定jar包,再將jar包進行解壓,找到對應目錄將資源拷貝到我們需要的地方便於訪問
掃描jar包
public static void copyFrameStaticFile() { String packageName = "com.haopan.frame"; // 獲取包的名字 並進行替換 String packageDirName = packageName.replace('.', '/'); // 定義一個枚舉的集合 並進行循環來處理這個目錄下的things Enumeration<URL> dirs; try { dirs = Thread.currentThread().getContextClassLoader().getResources(packageDirName); // 循環迭代下去 while (dirs.hasMoreElements()) { // 獲取下一個元素 URL url = dirs.nextElement(); // 得到協議的名稱 String protocol = url.getProtocol(); if ("jar".equals(protocol)) { // 如果是jar包文件 // 定義一個JarFile JarFile jar; try { // 獲取jar jar = ((JarURLConnection) url.openConnection()).getJarFile(); String templateDecompressPath = "tempfiles/decompress/" + CommonUtil.getNewGuid() + "/"; File targetFile = new File(templateDecompressPath); if (!targetFile.exists()) { targetFile.mkdirs(); } decompressJarFile(jar, templateDecompressPath); String frameStaticPath = templateDecompressPath + "public/"; File frameStaticFile = new File(frameStaticPath); if (frameStaticFile.exists()) { String copyTargetPath = "static/"; File copyTargetFolder = new File(copyTargetPath); if (copyTargetFolder.exists()) { FileUtil.deleteDirectory(copyTargetPath); } copyTargetFolder.mkdirs(); FileUtil.copyFileFolder(frameStaticPath, copyTargetPath); } FileUtil.deleteDirectory(templateDecompressPath); System.out.println("框架靜態文件復制完畢!"); } catch (IOException e) { e.printStackTrace(); } } } } catch (IOException e) { e.printStackTrace(); } }
解壓jar包
對JarFile中的JarEntry對象進行遍歷,判斷是文件還是目錄分類處理
public static synchronized void decompressJarFile(JarFile jf,String outputPath){ if (!outputPath.endsWith(File.separator)) { outputPath += File.separator; } File dir = new File(outputPath); if (!dir.exists()) { dir.mkdirs(); } try{ for (Enumeration<JarEntry> e = jf.entries(); e.hasMoreElements();) { JarEntry je = (JarEntry) e.nextElement(); String outFileName = outputPath + je.getName(); File f = new File(outFileName); if(je.isDirectory()){ if(!f.exists()){ f.mkdirs(); } }else{ File pf = f.getParentFile(); if(!pf.exists()){ pf.mkdirs(); } InputStream in = jf.getInputStream(je); OutputStream out = new BufferedOutputStream( new FileOutputStream(f)); byte[] buffer = new byte[2048]; int nBytes = 0; while ((nBytes = in.read(buffer)) > 0) { out.write(buffer, 0, nBytes); } out.flush(); out.close(); in.close(); } } }catch(Exception e){ System.out.println("解壓"+jf.getName()+"出錯---"+e.getMessage()); }finally{ if(jf!=null){ try { jf.close(); File jar = new File(jf.getName()); if(jar.exists()){ jar.delete(); } } catch (IOException e) { e.printStackTrace(); } } } }
拷貝目錄到指定位置
public class FileUtil { private static void copy(String f1, String f2) throws IOException { File file1=new File(f1); /* File file2=new File(f2);*/ File[] flist=file1.listFiles(); for (File f : flist) { if(f.isFile()){ copyFile(f.getPath(),f2+"/"+f.getName()); //調用復制文件的方法 //System.out.println("原路徑["+f.getPath()+"] 被復制路徑["+f2+"/"+f.getName()+"]"); }else if(f.isDirectory()){ copyFileFolder(f.getPath(),f2+"/"+f.getName()); //調用復制文件夾的方法 //System.out.println("原路徑["+f.getPath()+"] 被復制路徑["+f2+"/"+f.getName()+"]"); } } } /** * 復制文件夾 * @throws IOException */ public static void copyFileFolder(String sourceFolderPath,String targetFolderPath) throws IOException { //創建文件夾 File file=new File(targetFolderPath); if(!file.exists()){ file.mkdirs(); } copy(sourceFolderPath,targetFolderPath); } /** * 復制文件 * @throws IOException */ public static void copyFile(String sourceFilePath, String tagretFilePath) throws IOException { try { InputStream in = new FileInputStream(sourceFilePath); OutputStream out = new FileOutputStream(tagretFilePath); byte[] buffer = new byte[2048]; int nBytes = 0; while ((nBytes = in.read(buffer)) > 0) { out.write(buffer, 0, nBytes); } out.flush(); out.close(); in.close(); } catch (FileNotFoundException e) { e.printStackTrace(); } } public static boolean delete(String fileName) { File file =new File(fileName); if (!file.exists()) { //System.out.println("刪除文件失敗:" + fileName +"不存在!"); return false; }else { if (file.isFile()) return deleteFile(fileName); else return deleteDirectory(fileName); } } /** * 刪除單個文件 * * @param fileName:要刪除的文件的文件名 * @return 單個文件刪除成功返回true,否則返回false */ public static boolean deleteFile(String fileName) { File file =new File(fileName); // 如果文件路徑所對應的文件存在,並且是一個文件,則直接刪除 if (file.exists() && file.isFile()) { if (file.delete()) { //System.out.println("刪除單個文件" + fileName +"成功!"); return true; }else { //System.out.println("刪除單個文件" + fileName +"失敗!"); return false; } }else { //System.out.println("刪除單個文件失敗:" + fileName +"不存在!"); return false; } } /** * 刪除目錄及目錄下的文件 * * @param dir:要刪除的目錄的文件路徑 * @return 目錄刪除成功返回true,否則返回false */ public static boolean deleteDirectory(String dir) { // 如果dir不以文件分隔符結尾,自動添加文件分隔符 if (!dir.endsWith(File.separator)) dir = dir + File.separator; File dirFile =new File(dir); // 如果dir對應的文件不存在,或者不是一個目錄,則退出 if ((!dirFile.exists()) || (!dirFile.isDirectory())) { System.out.println("刪除目錄失敗:" + dir +"不存在!"); return false; } boolean flag =true; // 刪除文件夾中的所有文件包括子目錄 File[] files = dirFile.listFiles(); for (int i =0; i < files.length; i++) { // 刪除子文件 if (files[i].isFile()) { flag = deleteFile(files[i].getAbsolutePath()); if (!flag) break; } // 刪除子目錄 else if (files[i].isDirectory()) { flag = deleteDirectory(files[i].getAbsolutePath()); if (!flag) break; } } if (!flag) { //System.out.println("刪除目錄失敗!"); return false; } // 刪除當前目錄 if (dirFile.delete()) { //System.out.println("刪除目錄" + dir +"成功!"); return true; }else { return false; } } }
外部靜態資源訪問與優先級設置
設置yml文件中的static-locations配置項,多個使用,隔開,同時指定順序為訪問的優先級
spring: resources: static-locations: classpath:static/,classpath:public/,file:static/
最終目錄結構圖如下,框架部分完全是項目啟動時自動解壓拷貝的,項目部分則是由具體項目進行開發,項目部分也可以很方便的進行框架部分功能重構,例如登錄頁,主頁面修改等,本方式支持jar包和war包兩種打包方式
到此這篇關於SpringBoot靜態資源訪問控制和封裝集成方案的文章就介紹到這瞭,更多相關SpringBoot靜態資源訪問控制內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!