Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
A
app
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
hel-guide
app
Commits
67a1c2ce
Commit
67a1c2ce
authored
Aug 16, 2017
by
JingChao
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Updates ionic/ionic-code-style.md
Auto commit by GitBook Editor
parent
a0b48829
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
12 additions
and
125 deletions
+12
-125
ionic-code-style.md
ionic/ionic-code-style.md
+12
-125
No files found.
ionic/ionic-code-style.md
View file @
67a1c2ce
...
...
@@ -3,130 +3,17 @@
-
Eclipse中修改项目编码的方法参考:
[
Eclipse修改编码方法
](
http://jingyan.baidu.com/article/647f0115b0c9887f2148a822.html
)
-
IDEA中修改项目编码的方法参考:
[
IDEA修改编码方法
](
http://jingyan.baidu.com/article/948f5924e4de57d80ff5f998.html]
)
2.
提供他人使用的接口,原则上不允许修改
**方法签名**
,若是不再推荐使用,可以加
**@ Deprecated**
注解,同时提示新的接口名称。
3.
**DTO**
类中所有的字段,不允许设置
**默认值**
,且DTO必须
**重写toString()方法**
。
4.
原则上不允许使用递归,部分情况可以使用尾递归。
5.
代码中不允许出现魔法值,即未定义的任何常量。错误的用法不限于以下形式:
```
java
if
(
user
.
getStatus
()
==
5
){
// 5即为魔法值,应当避免使用
// do something
}
// 推荐使用常量
private
static
final
int
EXPIRED_USER_STATUS
=
5
;
if
(
user
.
getStatus
()
==
EXPIRED_USER_STATUS
){
// do something
}
```
6.
在类中定义的常量、变量及方法,需要严格控制访问修饰符,提供自己使用的设为private,可以供别人使用的可以设为public、protected等。
7.
所有的覆写方法,必须加
**@Override**
注解,防止错误的拼写导致意外。
8.
Long类型的数据在初始化时必须使用大写的字母L, Double类型的数据必须使用大写的字母D。常见形式如
-
**Long time=10000L**
-
**Double money=12.3D**
9.
所有的数值的包装类型之间的比较不允许使用
<
、
>
、==之类的简单运算符,需要使用equals方法或者compareTo方法。
10.
所有方法的引用类型参数,若是未添加
**@NotNull**
注解,必须先进行null判断。
11.
捕获异常一般不允许直接捕获基类Exception,也不可捕获异常后不进行处理。方法中也不可抛出基类Exception。
12.
部分异常若是上层(调用层)不能解决,则不允许抛出。最外层若是出现异常必须自行处理,不可将异常信息直接展示给用户。
13.
所有的日志信息
**不允许使用System.out.println**
输出,异常的日志信息使用
**log.error**
打印时,必须使用重载方法将捕获的异常作为第二个参数。如:
```
java
try
{
// throw some exceptions
}
catch
(
IOException
e
){
logger
.
error
(
e
.
getMessage
(),
e
);
}
2.
前端开发采用Angular的MVC模式,项目中预设了一些
`module`
每个
`module`
的作用在此简单说明
```
javascript
var
applicationModule
=
angular
.
module
(
'applicationModule'
,[]);
var
chartsModule
=
angular
.
module
(
'chartsModule'
,[]);
var
toolsModule
=
angular
.
module
(
'toolsModule'
,[]);
var
myInfoModule
=
angular
.
module
(
'myInfoModule'
,[]);
var
workflowModule
=
angular
.
module
(
'workflowModule'
,[]);
var
derectiveModule
=
angular
.
module
(
'derectiveModule'
,[]);
var
tabModule
=
angular
.
module
(
'tabModule'
,[]);
var
loginModule
=
angular
.
module
(
'loginModule'
,[]);
var
utilModule
=
angular
.
module
(
'utilModule'
,[]);
var
JPushServiceModule
=
angular
.
module
(
'JPushServiceModule'
,[]);
```
--- ---
## [二、后端命名规范](id:backEndName)
1.
所有的命名不允许使用
**拼音或者拼音英文混合**
方式,但部分公认的拼音允许使用,如
**shanghai,beijing**
等。
2.
所有的命名不允许使用
**下划线`_`**
或者
**美元符`$`**
作为起始或者结束。错误的情况有不限于以下几种:
-
**_param**
-
**$param**
-
**param_**
-
**param$**
-
**_param$**
### 包命名规范
1.
包名一般为域名倒序开头,后接项目名,再加上单数形式的名词(项目中一般使用模块代码),且全部为小写字母,如:
-
系统功能模块:
**com.hand.hls.sys**
-
合同功能模块:
**com.hand.hls.cont**
2.
在功能模块包中一般包含如下几种形式的包:
-
存放SpringMVC的控制层代码:
**controllers**
-
存放该模块数据库实体对象:
**dto**
-
存放该模块的部分组件:
**components**
-
存放该模块的业务接口:
**service**
-
存放该模块的业务实现类:
**service.impl**
-
存放该模块的Mybatis数据库交互层代码:
**mapper**
-
存放该模块的工具类代码:
**utils**
-
存放自定义的异常类代码:
**exception**
### 类命名规范
1.
一般类名采用Pascal命名法,所有单词的首字母大写,其余字母小写,单词与单词之间不使用
**下划线_**
分割,常见形式如:
-
**HlsClassName**
-
**HlsNormalClass**
2.
数据库实体类一般与数据表名称相同并改为Pascal命名规则,如:
-
**SysUser**
-
**SysRole**
3.
抽象类命名使用
**Abstract**
开头,接口一般以
**I**
开头,Mybatis的mapper对象可不用
**I**
开头但必须使用
**Mapper**
结尾,如:
-
**AbstractClass**
-
**ILog**
-
**SysUserMapper**
4.
业务逻辑层接口类使用
**I**
开头,且必须以
**Service**
结尾;业务的实现类在接口的基础上去掉开头的字母
**I**
,最后加上
**Impl**
,如:
-
**ISysUserService**
-
**SysUserServiceImpl**
5.
自定义的异常类以
**Exception**
结尾,如:
-
**UserNotFoundException**
-
**UserDefineException**
6.
项目中的测试类一般以测试对象的类名开头,以
**Test**
结尾,如:
-
**SysUserServiceImplTest**
7.
若是采用了设计模式的类,在命名时,可在最后添加设计模式的名称,如:
-
工厂模式:
**LoggerFactory**
-
代理模式:
**UserProxy**
-
适配器模式:
**ArrayAdapter**
### 变量命名规范
1.
成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式,即
**首单词**
字母都小写,后面单词的
**首字母大写**
。如
+
**hlsClassFieldName**
+
**hlsLocalParamName**
2.
数据库对象的成员变量中若是变量的类型为Boolean类型,则变量名不允许使用
**is**
开头,错误的命名如下:
-
**private Boolean isAdmin**
### 常量命名规范
1.
常量的命名一般所有单词都
**大写**
,各个单词之间使用下划线
`_`
分隔,如:
-
**PI**
-
**PROJECT_PATH**
2.
常量的命名尽量使用单词表达出常量的用途及含义,力求语义清晰,不用担心名字太长,如:
-
周期的第一天:
**FIRST_DAY_OF_CYCLE**
-
用户允许的最大错误次数:
**USER_ALLOWED_MAX_ERROR_COUNT**
### 方法命名规范
1.
方法的命名规则采用lowerCamelCase风格,方法名的首单词字母全部小写,其余单词首字母大写,如:
-
**walkMyWay()**
-
**doSomething()**
2.
对数据库进行查询的方法,一般以
**select、find、query**
开头,后面接查询的对象,若是查询结果为List集合,对象名可变为复数,如:
-
`public SysUser selectSysUser()`
-
`public List<SysRole> findSysRoles()`
3.
对数据进行数据插入的方法,一般以
**insert**
开头,后接插入的对象,若是允许批量插入对象,对象名可变为复数,如:
-
`public int insertSysUser(SysUser user)`
-
`public int insertSysRoles(List<SysRole> roles)`
4.
对数据库进行数据删除的方法,一般以
**delete**
开头,后接插入的对象,若是允许批量插入对象,对象名可变为复数,如:
-
`public int deleteSysUser(SysUser user)`
-
`public int deleteSysRoleByIds(List<Long> roleIds)`
5.
对数据库进行数据更新的方法,一般以
**update**
开头,后接插入的对象,若是允许批量插入对象,对象名可变为复数,如:
-
`public SysRole updateSysRole(SysRole role)`
-
`public int updateSysUsers(List<SysUser> users)`
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment