编码规范（待完善）

一、命名规范

1、项目名全部小写
2、包名全部小写
    在新建一个包项目时可能会涉及到多层设计，每层的包名要遵循包名全部小写的规范，如图在一个功能的逐层上级的包名全部是小写和字符组成

3、类名的命名要遵循首字母大写原则，类的名字必须由大写字母开头而单词中的其他字母均为小写；如果一个类名称是由多个单词组成，则每个单词的首字母均应为大写例如ModelWhAction；如果类名称中包含单词缩写，则这个所写词的每个字母均应大写，如：XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的，所以在命名类时应尽量选择名词。　　

4、变量的命名要遵循通俗易懂的原则，比如名字就用 name ，而不是用a、b、c这样的命名。变量命名除了变量名外，实例，包括类、类常量，均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。但是在工作中这样做会降低代码的可阅读性，在工作上这是不规范的。
5、方法的名字的第一个单词应以小写字母作为开头，后面的单词则用大写字母开头。
6、需要用到的变量命名和方法命名要遵循首字母小写原则，如果名称是由多个单词组成，每个单词的首字母都要大写（除首个单词）。
   如：public void toString(){}

7、使用驼峰命名法命名多个单词组成的变量名。 
如：modelFacade

8、常量命名时需要遵循名称全部大写的原则。
如：public staticfinal long BSDY_SHZT_SHZ = 2; // 审核中

9、所有命名规则必须遵循以下规则：
    1)、名称只能由字母、数字、下划线、$符号组成

    2)、命名时不能以数字开头

    3)、在命名是绝对不能出现Java关键字。

    4)、绝对不允许在命名时出现中文及拼音全名。

二、编码规范

      1.controller层不允许写sql语句

      2.service层涉及到数据库的修改操作都需要加事务

      3.代码注释量不能少于整体的30%

      4.代码整洁，删除无用代码和无用的引用

      5.按照分支版本开发的规范进行开发，不能直接修改主版本业务逻辑

三、三种数据源的基本操作规范

     1.spring-data-jpa

         1.1直接在repository层通过接口命名的方式编写

1.2使用@Query

1.2.1. 一个使用@Query注解的简单例子

@Query(value = "select name,author,price from Book b where b.price>?1 and b.price<?2")
List<Book> findByPriceRange(long price1, long price2);

1.2.2.  Like表达式

@Query(value = "select name,author,price from Book b where b.name like %:name%")
List<Book> findByNameMatch(@Param("name") String name);

1.2.3. 使用Native SQL Query

所谓本地查询，就是使用原生的sql语句（根据数据库的不同，在sql的语法或结构方面可能有所区别）进行查询数据库的操作。

@Query(value = "select * from book b where b.name=?1", nativeQuery = true)
List<Book> findByName(String name);

1.2.4. 使用@Param注解注入参数

@Query(value = "select name,author,price from Book b where b.name = :name AND b.author=:author AND b.price=:price")
List<Book> findByNamedParam(@Param("name") String name, @Param("author") String author,
        @Param("price") long price);

1.2.5. SPEL表达式(使用时请参考最后的补充说明)

   '#{#entityName}'值为'Book'对象对应的数据表名称(book)。

public interface BookQueryRepositoryExample extends Repository<Book, Long>{
       @Query(value = "select * from #{#entityName} b where b.name=?1", nativeQuery = true)
       List<Book> findByName(String name);

}

1.2.6. 一个较完整的例子

public interface BookQueryRepositoryExample extends Repository<Book, Long> {
    @Query(value = "select * from Book b where b.name=?1", nativeQuery = true) 
    List<Book> findByName(String name);// 此方法sql将会报错(java.lang.IllegalArgumentException)，看出原因了吗,若没看出来，请看下一个例子

    @Query(value = "select name,author,price from Book b where b.price>?1 and b.price<?2")
    List<Book> findByPriceRange(long price1, long price2);

    @Query(value = "select name,author,price from Book b where b.name like %:name%")
    List<Book> findByNameMatch(@Param("name") String name);

    @Query(value = "select name,author,price from Book b where b.name = :name AND b.author=:author AND b.price=:price")
    List<Book> findByNamedParam(@Param("name") String name, @Param("author") String author,
            @Param("price") long price);

}

1.2.7.  解释例6中错误的原因：

     因为指定了nativeQuery = true，即使用原生的sql语句查询。使用java对象'Book'作为表名来查自然是不对的。只需将Book替换为表名book。

@Query(value = "select * from book b where b.name=?1", nativeQuery = true)
List<Book> findByName(String name);

补充说明(2017-01-12)：

　　有同学提出来了，例子5中用'#{#entityName}'为啥取不到值啊？

　　先来说一说'#{#entityName}'到底是个啥。从字面来看，'#{#entityName}'不就是实体类的名称么，对，他就是。

　　实体类Book,使用@Entity注解后，spring会将实体类Book纳入管理。默认'#{#entityName}'的值就是'Book'。

　　但是如果使用了@Entity(name = "book")来注解实体类Book,此时'#{#entityName}'的值就变成了'book'。

　　到此，事情就明了了，只需要在用@Entity来注解实体类时指定name为此实体类对应的表名。在原生sql语句中，就可以把'#{#entityName}'来作为数据表名使用。

2.使用EntityManager

基本用法：

String sql=“from Book”;
Query query=entityManager.createQuery(sql);
List list = query.getResultList();

设置返回类型：

Query query=entityManager.createNativeQuery(sql);
query.unwrap(SQLQuery.class).setResultTransformer(Transformers.aliasToBean(Book.class));
List list = query.getResultList();

Query query=entityManager.createNativeQuery(sql);
query.unwrap(SQLQuery.class).setResultTransformer(Transformers.ALIAS_TO_ENTITY_MAP);
List list = query.getResultList();

3.使用spring jdbcTemplate

基本语法规范：

jdbcTemplate.update();
jdbcTemplate.batchUpdate();
jdbcTemplate.queryForObject();
jdbcTemplate.query(sql,new BeanPropertyRowMapper<Book>(Book.class));