`
andyjames
  • 浏览: 31434 次
  • 性别: Icon_minigender_1
  • 来自: 杭州
社区版块
存档分类
最新评论

Java模板Velocity模板编码规范

    博客分类:
  • Java
阅读更多
1、模板文件名称遵循类的命名规范,首字母小写,各单词首字母大写,其他字母小写的格式。
如:orderIntention.vm。

2、每个模板文件开头应该写上注释,说明该模板是展示那些数据,或者展示那个功能的。注释格式如下:
#######################
##注释内容
##注释内容
##注释内容
#######################

3、 模板中的变量名需要规范起来,变量名应该首字母小写,中间单词的首字母大写,其他字母小写的命名规范,比如:
变量名researchUrl为推荐形式,而research_url,ResearchUrl等都是不被推荐的形式;变量的名称最好能够见名知义,因此应该起一些有实际意义的单词,不建议使用单个字母作为变量
4、 模板中需要注意缩进,缩进格式是4各空格键(不使用tab),比如:
#if($testA)
    doSomeThingA()
#else
    #if($testB)
        doSomeThingB()
   #end
#end
严格的缩进能够清楚的展示哪个#end对应于哪个#if,让程序更加便于阅读和维护。

5、 尽可能让模板的逻辑代码和html代码脱离开,使模板代码更容易阅读。
6、 逻辑代码尽量写注释,以便增强逻辑代码的可读性。
7、 在模板中,变量名是很宝贵的资源,开发人员开发代码时,应该检查一下是否类似的变量已经存在,如果存在,就使用已有的变量,而不要再自己新造变量。(存在重复变量,比如OfferSearch.vm(拆分后变为SaleOfferSearch.vm)上的complexResult和searchResult,实际上值是一样的,但是使用了 两个变量名,这种情况也不推荐。应该尽量减少参数的名称,降低代码复杂度。)
8、 现在存在着好几个页面使用同一个变量的情况(变量代表的值是一样的),但是由于开发的人员和开发时间的不同,造成了这些变量在不同的页面里有不同的名字,这种情况要避免出现:开发人员开发的时候,需要有全局观念,在实现一些小需求时,最好能够对整个系统有所了解,了解系统中大部分的变量名,避免同一个变量在不同的页面叫不同的名字;同时,代码审核人员在审核代码时,也应该对这方面进行注意。
9、 参数输出和传递格式需要统一,在模板中需要输出变量时使用统一的格式,如:$!param;在设置参数的时候也使用统一格式,如:setParameter("param", $param);注意,在输出参数时必须加上感叹好"!",否则当参数为空时,直接输出$!param。
10、页面上的img和js地址统一使用配置变量,不要写死在页面上,
如:
http://img.zjzx.com/xxx/xxx/xxx.gif,而应该使用$!imgServer/xxx/xxx/xxx.gif。
http://style. zjzx.com/xxx/xxx/xxx.css,应该使用$!styleServer/xxx/xxx/xxx.css。
11、页面上指向其他应用的地址也尽量使用配置的方式,
如:
http://shoppingcart.alpress.com/shopcart/shopcartDetail.htm,应该是这样的,$!shopcartServer/shopcart/shopcartDetail.htm。
shopcartServer在uri.xml文件中配置,这样做的方便模板的维护。

12、页面上的引入js文件的代码,统一放在页面的最底端,以加快页面加载速度。
分享到:
评论

相关推荐

    JAVA中Velocity语法基础.pdf

    Velocity 应用于 web 开发时,界面设计人员可以和 Java 程序开发人员同步开发一个遵循 MVC 架构的 web 站点,也就是说,页面设计人员可以只关注页面的显示效果,而由 Java 程序开发人员关注业务逻辑编码。...

    java swing开发一款代码生成工具swing-generate,可通过velocity模板引擎在线定制模板

    通过自定义模板,可以确保生成的代码符合团队编码规范,减少手动编写时可能出现的错误。此外,随着项目需求的变化,只需更新模板,即可快速调整生成的代码结构。 总的来说,`swing-generate`是一款强大的代码生成...

    Velocity代码生成工具

    - **基本概念**:VTL是Velocity模板引擎使用的脚本语言,它提供了一系列内置对象、变量和指令来帮助生成动态内容。 - **变量**:用于存储数据值。 - **属性**:可以是字符串、数字或任何其他类型的数据。 - **方法**...

    基于Velocity的代码生成器

    【基于Velocity的代码生成器】是一种实用的工具,它利用Apache Velocity模板引擎来自动化Java代码的生成过程。在J2EE开发中,大量的重复性编码工作可以通过代码生成器来简化,提高开发效率和代码质量。 Velocity是一...

    linyi.rar 使用Velocity生成代码

    自动化生成的代码虽然能快速生成基础框架,但仍然需要开发者的审查和调整,以确保代码质量和遵循项目的编码规范。此外,当数据库表结构发生变化时,重新运行代码生成过程可快速更新相关代码。 7. **最佳实践** ...

    最快速的java代码生成器 rapid-generator

    开发者可以根据项目需求定制自己的代码模板,模板语言通常基于FreeMarker或者Velocity,这些模板语言允许用户自由控制代码结构和内容,确保生成的代码符合团队的编码规范和风格。 此外,Rapid-Generator还提供了...

    Velocity学习资料

    9. **最佳实践**:学习如何编写清晰、可维护的Velocity模板,遵循一定的编码规范和设计模式。 10. **性能优化**:理解Velocity的缓存机制,以及如何通过配置和编程优化模板的执行效率。 通过学习Velocity,你可以...

    JSP网页模板JSP网页模板JSP网页模板

    2. **合理使用指令标签**:正确配置指令标签,如设置字符编码、导入需要的Java类库。 3. **使用模板引擎**:引入Velocity或FreeMarker等模板引擎,提高代码质量。 4. **保持模板简洁**:模板应专注于展示数据,...

    mybatis逆向工程模板文件

    3. **模板文件的使用**:在MyBatis逆向工程中,用户可以自定义模板文件,以满足特定项目或团队的编码规范。例如,你可以定义实体类中的字段注释格式、Mapper接口的方法签名等。"templates-var"可能包含了各种不同的...

    自动生成代码 自定义配置,开放模板

    模板语言通常使用 Velocity 或 FreeMarker,允许开发者进行高度定制,例如改变字段注释的格式,添加自定义注解,或者调整类结构。开发者可以根据项目需求修改这些模板,以满足特定的编码风格和功能需求。 总结起来...

    velocity学习资料

    Velocity是Apache软件基金会下的一个开源项目,它是一个用于Java平台的模板引擎,主要用来生成动态网页内容。Velocity在Java开发中常被用作MVC(Model-View-Controller)架构中的视图层技术,帮助开发者将业务逻辑与...

    \velocity语法

    此外,还需要创建一个 Velocity 配置文件,指定模板文件的位置、字符编码等相关信息。 #### 三、Velocity 语法详解 ##### 3.1 变量引用 在 Velocity 中,可以通过 `$` 符号后跟变量名的方式引用变量。例如: ```...

    基于Freemarker模板的代码生成器后台代码(controller,service,dao)模板文件

    使用这套模板,开发者可以快速构建符合规范的Java Web应用后端代码,大大提高了开发效率。通过调整Freemarker模板,可以适应不同的项目需求和编码风格,实现高度定制化的代码生成。在实际使用时,需结合代码生成器...

    自己写的 代码生成工具

    开发者可以根据项目需求定制模板,使得生成的代码符合特定的编码规范和框架要求,如Spring MVC或MyBatis等。此外,由于Velocity与Java代码分离,模板文件更容易维护,团队成员可以独立修改和扩展。 在实际操作中,...

    JavaTemplate:模板工具

    7. **提高代码质量**:由于模板遵循一定的编码规范,使用模板生成的代码通常具有较高的质量和一致性。 8. **提高开发效率**:通过自动化生成常见代码,开发者可以将精力集中在核心业务逻辑上,减少繁琐的重复劳动。...

    Java 代码生成器

    2. **模板引擎**:如FreeMarker或Velocity,用于根据模板生成Java代码。 3. **配置文件**:如"MyCodeGen.xml",其中包含代码生成的详细设置,如数据库连接、表名、生成代码的目录等。 4. **代码模板**:这些模板定义...

    velocity简易教程

    当 Velocity 应用于 web 开发时,界面设计人员可以和 Java 程序开发人员同步开发一个遵循 MVC 架构的 web 站点,也就是说,页面设计人员可以只关注页面的显示效果,而由 Java 程序开发人员关注业务逻辑编码。...

    java实体生成器

    使用实体生成器时,应遵循一定的最佳实践,例如避免生成包含敏感信息的实体类,保持实体类的简洁性,以及定期检查生成的代码以确保其符合项目的编码规范。 总的来说,Java实体生成器是现代Java开发中的重要工具,...

    java 代码生成器

    - **一致性**:所有由生成器产出的代码风格一致,符合团队编码规范。 - **快速适应变化**:当业务需求发生变化时,只需修改生成规则,即可快速更新大量代码。 **2. 代码生成器的工作原理** - **元数据**:通常,...

    Java代码生成器-icoder

    它支持用户根据自己的需求定制模板,可以设置各种参数,如字段名、字段类型等,然后iCoder会根据这些参数生成符合规范的Java代码。 使用iCoder时,首先需要理解其基本概念。模板是iCoder的核心,它是预定义的代码...

Global site tag (gtag.js) - Google Analytics