spring自定义包扫描路径

桃扇骨 2022-11-30 15:50 449阅读 0赞

### springboot自定义包扫描路径 ###

*  项目结构
 *  注册包路径扫描类
 *  获取需要扫描的包路径，注册到spring
 *  读取配置文件

> 目标：  
> 项目springboot-jpa需要使用项目zzc-test的controller类

> 解决方案：  
> springboot-jpa引入依赖zzc-test，并在springboot-jpa中使用spring的componentScan方法注册新的扫描包路径

# 项目结构 #

![在这里插入图片描述][20200825093935142.png_pic_center]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2MjY0MjM3_size_16_color_FFFFFF_t_70_pic_center]

# 注册包路径扫描类 #

@Component
    public class ComponentScanRegister implements BeanDefinitionRegistryPostProcessor, PriorityOrdered { 
    	@Override
    	public int getOrder() { 
    		return PriorityOrdered.LOWEST_PRECEDENCE;
    	}
    	@Override
    	public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException { 
    	}
    
    	@Override
    	public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException { 
    	}
    }

# 获取需要扫描的包路径，注册到spring #

@Override
    	public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException { 
    		Set<String> packages =new HashSet<String>();
    		String configFileLocation = "META-INF/framework/component-scan-include.txt";
    		packages.addAll(getComponentScanList(configFileLocation));
    		//最终提交给 spring
    		if(packages!=null && packages.size()>0){ 
    			ClassPathBeanDefinitionScanner scanner =new ClassPathBeanDefinitionScanner(registry);
    			scanner.scan(packages.toArray(new String[]{ }));
    		}
    	}

# 读取配置文件 #

“META-INF/framework/component-scan-include.txt”  
component-scan-include.txt：

com.demo.service.impl
    com.demo.controller

private List<String> getComponentScanList(String configFileLocation) { 
    		List<String> result =new ArrayList<String>();
    		URL url =null;
    		try { 
    			Enumeration<URL> urls =Thread.currentThread().getContextClassLoader().getResources(configFileLocation);
    			if(urls!=null){ 
    				while (urls.hasMoreElements()) { 
    					url = urls.nextElement();
    					Resource resource =new UrlResource(url);
    					if(resource!=null && resource.exists()){ 
    						List<String> readLines = IOUtils.readLines(resource.getInputStream(), "utf-8");
    						result.addAll(readLines);
    					}
    				}
    				return result;
    			}
    		} catch (IOException e) { 
    			throw new RuntimeException("Error in configuration file : " + url,e);
    		}
    		return null;
    	}

[20200825093935142.png_pic_center]: /images/20221123/7b6862e5119f4202a7fd3a2e40532df0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2MjY0MjM3_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/75dd2cc412bb466ca558438efb61b88b.png