如何解决freemarker静态化生成html页面乱码的问题寻技术

freemarker静态化生成html页面乱码的问题

今天在整理之前所学的知识,在复习freemarker生成html页面的时候出现了中文乱码的问题,

在费了一番时间后终于找到问题的原因,觉得挺有意思,就把这段记录下来。

下面是springmvc的核心代码

 <!-- freemarker的配置 -->
    <bean id="freeMarkerConfigurer" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
            <!-- templateLoaderPath  :前缀 -->
            <property name="templateLoaderPath" value="/WEB-INF/ftl/"></property>
            <!-- 编码 -->
            <property name="defaultEncoding" value="utf-8"></property>
            <!-- 可选的配置 -->
            <property name="freemarkerSettings">
          <props>
                <prop key="template_update_delay">10</prop>
                <prop key="locale">zh_CN</prop>
                <prop key="datetime_format">yyyy-MM-dd HH:mm:ss</prop>
                <prop key="date_format">yyyy-MM-dd</prop>
                <prop key="time_format">HH:mm:ss</prop>
                <!-- 页面数值的显示格式 -->
                <prop key="number_format">#.##</prop><!-- 88,282,882,888,888 --><!-- 88282882888888.00  -->
            </props>
           </property>
     </bean>
     
     <!-- freemarker的解析器 -->
     <bean id="freeMarkerViewResolver" class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
         <!-- 后缀
         .ftl:是freemarker模板文件的后缀
          -->
           <property name="suffix" value=".ftl"></property>
           <property name="contentType" value="text/html;charset=utf-8"></property>
           <!-- 方便页面获得项目的绝对路径 -->
           <property name="requestContextAttribute" value="request"></property>
     </bean>

然后是controller的核心代码

@RequestMapping("/getHtml")
    public String getHtml(HttpServletRequest request,HttpServletResponse response) throws Exception{
        //第一步 freemarkerConfigurer得到一个Configure对象
        Configuration configuration = freeMarkerConfigurer.getConfiguration();
        //第二步 得到一个模版文件
        Template template = configuration.getTemplate("index.ftl");
        //第三步 构建数据模型
        Map<String, Object> map = new HashMap<String, Object>();
        map.put("uname", "zhangsan");
        map.put("bookList", BookDaoImpl.getBookList());
        System.out.println(BookDaoImpl.getBookList().get(0).getAuthor());
        //第四步 指定一个文件夹 构建一个输出流
        String dir = request.getSession().getServletContext().getRealPath("/WEB-INF/");
        //PrintWriter printWriter = new PrintWriter(new FileWriter(new File(dir,"index.html")));
        System.out.println(dir);
        //第五步 数据模型+模版文件 = 输出(控制台输出,html文件)
        template.process(map, printWriter);
        printWriter.flush();
        return "success";
    }

最后页面提示成功生成html页面

但在进入生成的html页面时发生了乱码

在网上也查了下大致给了以下几种解决方案

首先是说ftl文件的head上加上

<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

因为我在springmvc的视图解析器配置了

<property name="contentType" value="text/html;charset=utf-8"></property>

所以这个选择首先pass掉，然后说是在controller里加上

configuration.setDefaultEncoding("UTF-8");

不过因为我在freemarker的环境配置我也配置了默认的编码

<!-- 编码 -->
<property name="defaultEncoding" value="utf-8"></property>

所以应该也不是这个原因，后来我找到生成的html文件，发现用浏览器查看源代码虽然会乱码，但用记事本打开的时候所显示并没有乱码，然后判断是输出流的问题，通过网上查找发现FileWriter和FileReader使用的是系统默认的编码方式，因为fileWriter本身不具有用户指定编码的方式，这里选择使用filewriter 的父类OutputStreamWriter来读写操作，把代码

String dir = request.getSession().getServletContext().getRealPath("/WEB-INF/");
//PrintWriter printWriter = new PrintWriter(new FileWriter(new File(dir,"index.html")));

替换成

String dir = request.getSession().getServletContext().getRealPath("/WEB-INF/index.html");
        OutputStreamWriter writer = new OutputStreamWriter(new FileOutputStream(dir), "UTF-8");
        PrintWriter printWriter = new PrintWriter(writer);

后启动程序

乱码解决了，很开心！

freemarker页面静态化步骤以及相关注意事项

Freemarker

导入坐标

<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.23</version>
</dependency>

创建模板文件

<html>
<head>
<meta charset="utf-8">
<title>Freemarker入门</title>
</head>
<body>
<#--我只是一个注释，我不会有任何输出 -->
${name}你好，${message}
</body>
</html>

生成文件

public static void main(String[] args) throws Exception{
//1.创建配置类
Configuration configuration=new Configuration(Configuration.getVersion());
//2.设置模板所在的目录
configuration.setDirectoryForTemplateLoading(new File("D:\\ftl"));
//3.设置字符集,读取文件的编码
configuration.setDefaultEncoding("utf-8");
//4.加载模板
Template template = configuration.getTemplate("test.ftl");
//5.创建数据模型
Map map=new HashMap();
map.put("name", "张三");
map.put("message", "欢迎来到中国！");
//6.创建Writer对象
//   // 指定输出编码格式 utf-8
        Writer writer = new BufferedWriter(new OutputStreamWriter(new FileOutputStream ("d:\\ftl\\test.html"),"UTF-8"));
//Writer out =new FileWriter(new File("d:\\test.flt"));
//7.输出
template.process(map, out);
//8.关闭Writer对象
out.close();
}

例子

分析

前面我们已经学习了Freemarker的基本使用方法，下面我们就可以将Freemarker应用到项目中，帮我们生成移动端套餐列表静态页面和套餐详情静态页面。

接下来我们需要思考几个问题：

（0）那些页面应该静态化? 数据不经常发生变化,访问量大的

（1）什么时候生成静态页面比较合适呢？

（2）将静态页面生成到什么位置呢？

（3）应该生成几个静态页面呢？

对于第一个问题，应该是当套餐数据发生改变时，需要生成静态页面，即我们通过后台系统修改套餐数据（包括新增、删除、编辑）时。
对于第二个问题，如果是在开发阶段可以将文件生成到项目工程中，如果上线后可以将文件生成到移动端系统运行的tomcat中。
对于第三个问题，套餐列表只需要一个页面就可以了，在这个页面中展示所有的套餐列表数据即可。套餐详情页面需要有多个，即一个套餐应该对应一个静态页面。

模板

mobile_setmeal.ftl

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <!-- 上述3个meta标签*必须*放在最前面，任何其他内容都*必须*跟随其后！ -->
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0,user-scalable=no,minimal-ui">
    <meta name="description" content="">
    <meta name="author" content="">
    <link rel="icon" href="../img/asset-favico.ico" rel="external nofollow"  rel="external nofollow" >
    <title>预约</title>
    <link rel="stylesheet" href="../css/page-health-order.css" rel="external nofollow"  />
</head>
<body data-spy="scroll" data-target="#myNavbar" data-offset="150">
<div class="app" id="app">
    <!-- 页面头部 -->
    <div class="top-header">
        <span class="f-left"><i class="icon-back" onclick="history.go(-1)"></i></span>
        <span class="center">大鹅健康</span>
        <span class="f-right"><i class="icon-more"></i></span>
    </div>
    <!-- 页面内容 -->
    <div class="contentBox">
        <div class="list-column1">
            <ul class="list">
                <#list setmealList as setmeal>
                    <li class="list-item">
                        <a class="link-page" href="setmeal_detail_${setmeal.id}.html" rel="external nofollow" >
                            <img class="img-object f-left"
                                 src="http://py25jppgz.bkt.clouddn.com/${setmeal.img}"
                                 alt="">
                            <div class="item-body">
                                <h4 class="ellipsis item-title">${setmeal.name}</h4>
                                <p class="ellipsis-more item-desc">${setmeal.remark}</p>
                                <p class="item-keywords">
                                    <span>
                                        <#if setmeal.sex == '0'>
                                            性别不限
                                        <#else>
                                            <#if setmeal.sex == '1'>
                                                男
                                            <#else>
                                                女
                                            </#if>
                                        </#if>
                                    </span>
                                    <span>${setmeal.age}</span>
                                </p>
                            </div>
                        </a>
                    </li>
                </#list>
            </ul>
        </div>
    </div>
</div>
<!-- 页面 css js -->
<script src="../plugins/vue/vue.js"></script>
<script src="../plugins/vue/axios-0.18.0.js"></script>
</body>

模板

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <!-- 上述3个meta标签*必须*放在最前面，任何其他内容都*必须*跟随其后！ -->
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0,user-scalable=no,minimal-ui">
    <meta name="description" content="">
    <meta name="author" content="">
    <link rel="icon" href="../img/asset-favico.ico" rel="external nofollow"  rel="external nofollow" >
    <title>预约详情</title>
    <link rel="stylesheet" href="../css/page-health-orderDetail.css" rel="external nofollow"  />
    <script src="../plugins/vue/vue.js"></script>
    <script src="../plugins/vue/axios-0.18.0.js"></script>
    <script src="../plugins/healthmobile.js"></script>
</head>
<body data-spy="scroll" data-target="#myNavbar" data-offset="150">
<div id="app" class="app">
    <!-- 页面头部 -->
    <div class="top-header">
        <span class="f-left"><i class="icon-back" onclick="history.go(-1)"></i></span>
        <span class="center">大鹅健康</span>
        <span class="f-right"><i class="icon-more"></i></span>
    </div>
    <!-- 页面内容 -->
    <div class="contentBox">
        <div class="card">
            <div class="project-img">
                <img src="http://py25jppgz.bkt.clouddn.com/${setmeal.img}"
                     width="100%" height="100%" />
            </div>
            <div class="project-text">
                <h4 class="tit">${setmeal.name}</h4>
                <p class="subtit">${setmeal.remark}</p>
                <p class="keywords">
                    <span>
                        <#if setmeal.sex == '0'>
                            性别不限
                        <#else>
                            <#if setmeal.sex == '1'>
                                男
                            <#else>
                                女
                            </#if>
                        </#if>
                    </span>
                    <span>${setmeal.age}</span>
                </p>
            </div>
        </div>
        <div class="table-listbox">
            <div class="box-title">
                <i class="icon-zhen"><span class="path1"></span><span class="path2"></span></i>
                <span>套餐详情</span>
            </div>
            <div class="box-table">
                <div class="table-title">
                    <div class="tit-item flex2">项目名称</div>
                    <div class="tit-item  flex3">项目内容</div>
                    <div class="tit-item  flex3">项目解读</div>
                </div>
                <div class="table-content">
                    <ul class="table-list">
                        <#list setmeal.checkGroups as checkgroup>
                            <li class="table-item">
                                <div class="item flex2">${checkgroup.name}</div>
                                <div class="item flex3">
                                    <#list checkgroup.checkItems as checkitem>
                                        <label>
                                            ${checkitem.name}
                                        </label>
                                    </#list>
                                </div>
                                <div class="item flex3">${checkgroup.remark}</div>
                            </li>
                        </#list>
                    </ul>
                </div>
                <div class="box-button">
                    <a @click="toOrderInfo()" class="order-btn">立即预约</a>
                </div>
            </div>
        </div>
    </div>
</div>
<script>
    var vue = new Vue({
        el:'#app',
        methods:{
            toOrderInfo(){
                window.location.href = "orderInfo.html?id=${setmeal.id}";
            }
        }
    });
</script>
</body>

配置文件

（1）在health_service_provider工程中创建属性文件freemarker.properties 通过上面的配置可以指定将静态HTML页面生成的目录位置

out_put_path=静态页面生成的位置

在spring的中进行配置

<bean id="freemarkerConfig"
class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
<!--指定模板文件所在目录-->
<property name="templateLoaderPath" value="/WEB-INF/ftl/" />
<!--指定字符集-->
<property name="defaultEncoding" value="UTF-8" />
</bean>
<context:property-placeholder location="classpath:freemarker.properties"/>

13 java 代码

   @Autowired
    private SetmealDao setmealDao;
    @Autowired
    private JedisPool jedisPool;
    @Autowired
    private CheckGroupDao checkGroupDao;
    @Autowired
    private CheckItemDao checkItemDao;
    @Autowired
    private FreeMarkerConfigurer freeMarkerConfigurer;
    @Value("${out_put_path}")
    private String outPutPath;//从属性文件中读取要生成的html对应的目录
//新增套餐，同时关联检查组
    public void add(Setmeal setmeal, Integer[] checkgroupIds) {
        setmealDao.add(setmeal);
        Integer setmealId = setmeal.getId();//获取套餐id
        this.setSetmealAndCheckGroup(setmealId,checkgroupIds);
        //完成数据库操作后需要将图片名称保存到redis
        jedisPool.getResource().sadd(RedisConstant.SETMEAL_PIC_DB_RESOURCES,setmeal.getImg());

        //当添加套餐后需要重新生成静态页面（套餐列表页面、套餐详情页面）
        generateMobileStaticHtml();
    }

    //生成当前方法所需的静态页面
    public void generateMobileStaticHtml(){
        //在生成静态页面之前需要查询数据
        List<Setmeal> list = setmealDao.findAll();

        //需要生成套餐列表静态页面
        generateMobileSetmealListHtml(list);

        //需要生成套餐详情静态页面
        generateMobileSetmealDetailHtml(list);
    }

    //生成套餐列表静态页面
    public void generateMobileSetmealListHtml(List<Setmeal> list){
        Map map = new HashMap();
        //为模板提供数据，用于生成静态页面
        map.put("setmealList",list);
        generteHtml("mobile_setmeal.ftl","m_setmeal.html",map);
    }

    //生成套餐详情静态页面（可能有多个）
    public void generateMobileSetmealDetailHtml(List<Setmeal> list){
        for (Setmeal setmeal : list) {
            Map map = new HashMap();
            map.put("setmeal",setmealDao.findById4Detail(setmeal.getId()));
            generteHtml("mobile_setmeal_detail.ftl","setmeal_detail_" + setmeal.getId() + ".html",map);
        }
    }

    //通用的方法，用于生成静态页面
    public void generteHtml(String templateName,String htmlPageName,Map map){
        Configuration configuration = freeMarkerConfigurer.getConfiguration();//获得配置对象
        Writer out = null;
        try {
            Template template = configuration.getTemplate(templateName);
            //构造输出流
            // 中文乱码  
            //out = new BufferedWriter (new OutputStreamWriter (new FileOutputStream (outPutPath + "/" + htmlPageName),"UTF-8"));            //构造输出流
            out = new FileWriter(new File(outPutPath + "/" + htmlPageName));
            //输出文件
            template.process(map,out);
            out.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

生成静态页面的通用方法

    //通用的方法，用于生成静态页面(参数:templateName:模板,htmlPageName:生成的文件名称,Map:数据)
    public void generteHtml(String templateName,String htmlPageName,Map map){
        Configuration configuration = freeMarkerConfigurer.getConfiguration();//获得配置对象
        Writer out = null;
        try {
            Template template = configuration.getTemplate(templateName);
            //构造输出流
            // 中文乱码  
            //out = new BufferedWriter (new OutputStreamWriter (new FileOutputStream (outPutPath + "/" + htmlPageName),"UTF-8"));            //构造输出流
            out = new FileWriter(new File(outPutPath + "/" + htmlPageName));
            //输出文件
            template.process(map,out);
            out.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

14 -测试

  public void genById(Integer setmealId){
        Map map = new HashMap();
        map.put("setmeal",setmealDao.findById4Detail(setmealId));
        generteHtml("mobile_setmeal_detail.ftl","setmeal_detail_" + setmealId + ".html",map);
    }