Javaプログラミング仕様の心得
6280 ワード
Java ，“ ， ”—— （ ）。 ruby webx ， ， ， 。1.
a) （ ， ， List Map ， ）
b) ， ， ，
：
/**
* ID ， ， ：
* [ .ID, . ], [ X.ID, X. ], …[ .ID, . ]。
*
* @param catPath
*
* @return String[][]
*
*/
String[][] getCategoryStringByPath(String catPath);
: はずっと で、 ロジックの が なので、 の にこの でテストした と の ロジックの を えて します.このように、 ロジックの やこの が された 、 このテストコードを したり したりすることができます. なコードや いコードをプログラムに しておくのではなく、コードをますます くし、ますます みにくくします.
2.メソッドのコメントでは、パラメータの と り の を に く/**
* null ”"。
*
* StringUtil.isEmpty(null) = true
* StringUtil.isEmpty(“”) = true
* StringUtil.isEmpty(” “) = false
* StringUtil.isEmpty(“bob”) = false
* StringUtil.isEmpty(“ bob “) = false
*
*
*@param strチェックする
*
*@returnが の はtrueを します.
*/
public static boolean isEmpty(String str) {
return ((str == null) || (str.length() == 0));
}
:このコードは1 しかないのに、8 の をつけて、 しただけでなく、このコードは をしているのか、5つの を げてプログラム の な を しました.このように の はこのコードを むと、この の が なのかをよく っていて、コードを む を らします. たち のテストスクリプト( な)も の を にして、 の いたスクリプトに しい を えて、スクリプトのメンテナンスと の を にすることができます.
3. なコードを け、 なimportがなく、 なメンバー がなく、 なprivateメソッドがありません.
:コードやスクリプトの さを らし、コードの を めることができます.
4.メソッドのパラメータは5 を えないでください.パラメータが すぎる は、オブジェクトパッケージ( えばQuery)を します.
:
/**
* user can update the specified item, so prepare an DO and update database with that DO.
*
* @param vo – user submitted data
* @param sellerID – seller ID
* @param itemID – item ID
*
* @return -
*
* @link Result
*/
private Result updateItem(BidItemVO vo, String sellerID, String itemID, List lvo, String hasUpload, long limitCode) {}
: のこの は で6つのパラメータがあって、 6のパラメータは が えたので、パラメータが すぎて のパラメータが をしているのか らないので、この を び す があります.
:
/**
* ruyue 2007-06-11
*
* @param String
* itemId, String dbRoute
* @return title id pictUrl ownerId price auctionType end props category
*/
public Result getAuctionDetail4Mercury(ItemDetailQuery query) {}
5.「import java.io.*;を します.
:このようなimport では、 くの に たないクラスをプログラムに します. のEclipseは、ロードするクラスを に し、すべてのクラスをロードすることはありませんが、コードやスクリプトを くときは けなければならない い です.
6. すぎる 、 えばand、orが ある 、かっこをつけて し、 する.
:andとorの を らないにかかわらず、 が すぎる は、できるだけ をつけるべきで、このように エラーを らすことができて、コードの を して、 でコードのメンテナンスを にすることができます.
7. を に し、ハードコーディング( き みが んだ) 、 をできるだけ ける.
: や を に かないで、できるだけ を って、この に をつけて、 い コード(このif が をしているのか も らないので)がプログラムに っていることを けなければなりません.
8. のクラスにメソッドを します.このクラスが で されていない は、 、 、コメントを することをお めします. のメソッドに やその のビジネスロジックを するには、 ずコメントしてください./**
* ruyue 2007-06-11
*
* @param String
* itemId, String dbRoute
* @return title id pictUrl ownerId price auctionType end props category
*/
public Result getAuctionDetail4Mercury(ItemDetailQuery query) {}
if (ucBaseDO == null || ucBaseDO.isGradeNormal()) { // ，
// VIP
if (user.isRegieUser()) {
// VIP wanjian 2007.03.26
UserCardBaseDO mallVipCardDO = this.userCardManager
.findMallVIPCard(query.getLoginUserId(),
user.getUserId(), query
.getTrackNick());
if (mallVipCardDO != null) {
if (ucBaseDO == null) {
ucBaseDO = mallVipCardDO;
} else if (mallVipCardDO.getCurGradeIndex() > ucBaseDO
.getCurGradeIndex()) {
ucBaseDO = mallVipCardDO;
}
}
}
}
: が したクラスやメソッドに のコードを れるときは、クラスのヘッダや した に の 、 、コメントを れます.これにより、コードのメンテナンスを にし、コードの み り を め、できるだけ くエラーをチェックすることができます.
9. の は ちに しなければならない.
: が する :ユーザー を えずmapにputするが、このmapからユーザー を したことがないため、メモリが なくなり、 できない をもたらす.
10.「||」&&&」 では, が さく,しばしば する に に する.
: の さいものを に し、この の 、 の をしなくても を ることができ、コストを することができるかもしれません.
11.テストクラスで されるパラメータは、 メソッド に することが ましい.
: を でテストするのに です.
12. は、 にeditページにアクセスし、コミット の に してeditページに り、エラーが したページで データが われないようにすることに してください.
: は1つのケースを かち いました: めてeditページに って した 、 に してeditページに り、ページ の でない が われました.このケースは、 からテスト・インスタンスでこの が きされていましたが、ビジネス・プロセスで に したり、 に したりした 、 、 、リクエストに したりするには、データの やその のエラーがあるかどうかを することに するように しています.
13.パラメータ を に う
a)Publicタイプの は、 をする に、 したパラメータがあなたの に することを しなければならない.public boolean isMatchMD5(String source, String encodedStr) {
if (StringUtil.isBlank(source) || StringUtil.isBlank(encodedStr)) {
return false;
}
if (!CodesUtil.encodeMD5(source).equals(encodedStr)) {
return false;
}
return true;
}
:「 からも されるパラメータを しない」-- さん、Publicメソッドは の に び される が い.パラメータが されるときに される が いパラメータはあなたの に わないので、メソッドにパラメータチェックを れなければなりません.テスト にとっては「 からも されたパラメータに が まれているとは じないでください」と います.
b)パラメータ の は で、 の が さいことを する.
は が《Javaプログラミング 》の の に しても たちのテストの しの を って、みんなの の とコードに つことを んでいます.
は ず Taobao QA Team、 を しなければならない.http://qa.taobao.com/?p=8400