freemarker自定义指令

怼烎@ 2024-02-19 18:38 6阅读 0赞

最近项目中使用了spring boot搭建项目,使用spring security管理项目中的权限，使用freemarker作为视图层。为了将权限控制到按钮上，因此考虑直接使用spring security的标签实现，但是在整合的过程中，没有整合出来，突然想到freemarker可以自定义指令实现一些功能，因此记录一下，在freemarker中如何实现一个自定义指令，来达到实现部分内容的显示和隐藏。

**需求**：自定义一个freemarker标签，当满足某些条件的时候显示标签体中的内容，否则不进行显示。

**实现步骤：**

1、编写一个类实现 **TemplateDirectiveModel** 接口（freemarker实现自定义标签需要实现这个接口）

2、编写一个freemarker的配置类，在freemarker的Configuration中注册这个自定义标签

3、页面上进行使用

**一、编写一个类实现TemplateDirectiveModel接口**

public class AuthDirective implements TemplateDirectiveModel {
    
    	private static final String AUTH = "auth";
    
    	@Override
    	public void execute(Environment environment, Map map, TemplateModel[] templateModels, TemplateDirectiveBody templateDirectiveBody) throws TemplateException, IOException {
    		// 1.获取用户所有的权限
    		Collection<? extends GrantedAuthority> authorities = SecurityContextHolder.getContext().getAuthentication().getAuthorities();
    		// 2.获取标签中auth属性的值，此处我知道前台页面传递过来的是String类型，所以可以直接强制转换成SimpleScalar类型
    		SimpleScalar auth = (SimpleScalar) map.get(AUTH);
    		// 3、给页面上的循环变量设置值
    		if (null != templateModels && templateModels.length > 0) {
    			templateModels[0] = new SimpleScalar("<span style='color:red'>这个是后台返回的值</span>"); // 返回给前台一个String的类型
    			templateModels[1] = new StringArraySequence(new String[]{"张三", "李四", "王五"});         // 返回给前台一个Sequence类型
    		}
    		// 4.判断用户是否拥有这个权限
    		if (authorities.contains(new SimpleGrantedAuthority(auth.getAsString()))) {
    			// 显示指令包含的中间的内容
    			templateDirectiveBody.render(environment.getOut());
    		}
    	}
    }

**注：1、map中的key是String类型，value是TemplateModel类型**

**2、key可以简单的理解为自定义标签中的属性值，value为属性对应的值, key和value是可以有多个的。**

**3、eg <@auth auth="03"></@auth> ===> key=auth value=03**

**4、templateDirectiveBody可以简单理解为标签体中的内容**

**5、templateModels这个是循环变量<@auth auth="03";loopVar01></@auth>  loopVar01这个就是一个循环变量，后台赋值之后，前台可以获取到这个值**

**二、注册这个自定义标签**

@Configuration
    public class FreemarkerConfig implements InitializingBean {
    
    	@Autowired
    	@Qualifier("freeMarkerConfiguration")
    	private freemarker.template.Configuration freeMarkerConfiguration;
    
    	@Bean
    	public AuthDirective authDirective() {
    		return new AuthDirective();
    	}
    
    	@Override
    	public void afterPropertiesSet() throws Exception {
    		freeMarkerConfiguration.setSharedVariable("auth", authDirective());
    	}
    }

**注：上方的auth表示页面上的自定义的标签标签名是auth**

**三、页面上使用(我页面上登录的用户是有03权限，没有01权限)**

<@auth auth="03";loopVar01,loopVar02>
    我可以出来,获取到后台返回${
        loopVar01}<br/>
    <#list loopVar02 as loop>
    per : ${
        loop_index}-${
        loop}
        </#list>
    </@auth>
    <@auth auth="01">
    因为我没有这个权限，所以出不来
    </@auth>auth auth="03";loopVar01,loopVar02>
    我可以出来,获取到后台返回${
       loopVar01}<br/>
    <#list loopVar02 as loop>
    per : ${
       loop_index}-${
       loop}
        </#list>
    </@auth>
    <@auth auth="01">
    因为我没有这个权限，所以出不来
    </@auth>

**注：@auth 这个就是自定义标签，此处表示是auth标签 auth="03" 表示有一个属性是auth,并且它的值是03**

**loopVar01和loopVar02都是后台返回给前台的数据**

**四、运行效果**  
![aHR0cDovL2RsMi5pdGV5ZS5jb20vdXBsb2FkL2F0dGFjaG1lbnQvMDEyNy84NDk3L2YxOWEyZDJkLTc3ZWItM2M4YS05MDZjLTNhZDY1NmZhYjVlZi5wbmc][]  
**注**： **可以看到拥有03权限中的内容出来了，而01权限中的内容没有出来，因此就达到了我们要实现的效果。**

[aHR0cDovL2RsMi5pdGV5ZS5jb20vdXBsb2FkL2F0dGFjaG1lbnQvMDEyNy84NDk3L2YxOWEyZDJkLTc3ZWItM2M4YS05MDZjLTNhZDY1NmZhYjVlZi5wbmc]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/f284dc087cd9454984a8be8115bbb413.png