Skip to content

Commit

Permalink
#1 初始化项目
Browse files Browse the repository at this point in the history
  • Loading branch information
@calvin1978
calvin1978 committed May 30, 2018
1 parent a2edf8f commit 9cb0117
Show file tree
Hide file tree
Showing 18 changed files with 302 additions and 82 deletions.
7 changes: 1 addition & 6 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,5 @@
.classpath
*.log
target/
vjkit/bin
vjkit/docs
vjkit/CHANGELOG.md
vjmap/bin
vjtop/bin
standard/docs/ali1.3.1.pdf
vip-book.md
standard/docs/vip-book.md
201 changes: 201 additions & 0 deletions LICENSE.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [2006-2012] [www.springside.org.cn]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
32 changes: 30 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# vjtools
唯品会JDK 问题排查及性能调优工具
# VJTools

主力于Java的唯品会，关于Java的一些小家底。 [![Build Status](https://travis-ci.org/vipshop/vjtools.svg?branch=master)](https://travis-ci.org/vipshop/vjtools)


# Java开发手册

| 项目 | 描述 |
| -------- | -------- |
| [standard](/standard) | 唯品会Java开发手册|
| [code formatter](/standard/formatter) | 格式化模板 |


# 核心类库

| 项目 | 描述 |
| -------- | -------- |
| [vjkit](/vjkit) | 关于文本，集合，并发，反射等基础功能的核心类库 |


# Java工具集


| 项目 | 描述 |
| -------- | -------- |
| [vjmap](/vjmap) | 打印堆内各分代中对象的统计信息 |
| [vjtop](/vjtop) | 打印JVM概况及繁忙的java线程 |


其他推荐的三方问题排查及性能调优工具包括：btrace，greys，async-profiler
10 changes: 5 additions & 5 deletions standard/docs/chapter01.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,16 +89,16 @@ private static Logger logger = Logger.getLogger(MyClass.class);

1）如果上下文很清晰，局部变量可以使用 `list` 这种简略命名， 否则应该使用 `userList` 这种更清晰的命名。

<br/>

2）禁止 `a1, a2, a3` 这种带编号的没诚意的命名方式。

<br/>

3）方法的参数名叫 `bookList` ，方法里的局部变量名叫 `theBookList` 也是很没诚意。

<br/>

4）如果一个应用里同时存在 `Account、AccountInfo、AccountData` 类，或者一个类里同时有 `getAccountInfo()、getAccountData()`, `save()、 store()` 的函数，阅读者将非常困惑。

<br/>

5） `callerId` 与 `calleeId`， `mydearfriendswithA` 与 `mydearfriendswithB` 这种拼写极度接近，考验阅读者眼力的。

----
Expand Down Expand Up @@ -168,4 +168,4 @@ public class B extends A {

----

* [下一章：格式规约](chapter02.md)
* [下一章：格式规约](chapter02.md)
12 changes: 6 additions & 6 deletions standard/docs/chapter02.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@

1）IDE的默认代码格式模板，能简化绝大部分关于格式规范(如空格，括号)的描述。

<br/>

2）统一的模板避免不同开发者之间，因为格式不统一，产生代码合并冲突。另外，代码变更日志中因为格式不同引起的变更，也会掩盖了真正的逻辑变更。

<br/>

3）设定项目组统一的行宽，建议120。

<br/>

4）设定项目组统一的缩进方式(Tab或二空格，四空格均可)，基于IDE自动转换。

<br/>

* [VIP标准代码格式化模板](/standard/formatter)

----
Expand All @@ -40,7 +40,7 @@ if ((a == b) && (c == d))

按方法的对阅读者的关心程度排列，如果公有方法可以分成几组，私有方法也可以紧跟公有方法分组。

<br/>

2）当一个类有多个构造方法，或者多个同名的重载方法，这些方法应该按顺序放置在一起。其中参数较多的方法在后面。

```java
Expand All @@ -51,7 +51,7 @@ public void foo(int a) {...}
public void foo(int a, String b) {...}
```

<br/>

3）作为调用者的方法，尽量放在被调用的方法前面。

```java
Expand Down
10 changes: 5 additions & 5 deletions standard/docs/chapter04.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,12 @@ try {

例外: 你不希望依赖整个对象，传播了类之间的依赖性。

<br/>

2）将多个参数合并为一个新创建的逻辑对象。

例外: 多个参数之间毫无逻辑关联。

<br/>

3）将函数拆分成多个函数，让每个函数所需的参数减少。

* [Sonar-107: Methods should not have too many parameters](https://www.sonarsource.com/products/codeanalyzers/sonarjava/rules.html#RSPEC-107)
Expand Down Expand Up @@ -85,12 +85,12 @@ Validate.isTrue(length > 2, "length is %d, less than 2", length);

1） 极有可能被循环调用的方法。

<br/>

2） 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。

比如，一般DAO层与Service层都在同一个应用中，所以DAO层的参数校验，可以省略。

<br/>

3） 被声明成private，或其他只会被自己代码所调用的方法，如果能够确定在调用方已经做过检查，或者肯定不会有问题则可省略。

即使忽略检查，也尽量在方法说明里注明参数的要求，比如vjkit中的@NotNull，@Nullable标识。
Expand Down Expand Up @@ -162,4 +162,4 @@ a.hello(arrayList);
----

* [上一章：注释规约](chapter03.md)
* [下一章：类设计](chapter05.md)
* [下一章：类设计](chapter05.md)
Loading

0 comments on commit 9cb0117

Please sign in to comment.