Merge pull request #367 from AlesInfiny/feature/Spotbugsの警告に対応する

Checkstyle、Code Spell Checker、SpotBugs、Visual Studio Codeで発生した警告の修正

samples/web-csr/dressca-backend/.vscode/settings.json

@@ -2,15 +2,28 @@
   "java.dependency.packagePresentation": "hierarchical",
   "java.configuration.updateBuildConfiguration": "automatic",
   "java.checkstyle.configuration": "${workspaceFolder}\\config\\checkstyle\\checkstyle.xml",
+  "java.format.settings.url": "${workspaceFolder}\\config\\formatter\\eclipse-formatter.xml",
   "cSpell.words": [
+    "Appender",
     "applicationcore",
+    "assertj",
     "Batis",
     "controlleradvice",
     "Dressca",
+    "Incrementer",
+    "jdbc",
     "Mybatis",
     "Servlet",
     "shikuchoson",
+    "skiprows",
+    "springframework",
     "systemcommon",
-    "todofuken"
-  ]
+    "tasklet",
+    "todofuken",
+  ],
+  "[java]" : {
+    "editor.formatOnSave": true,
+    "editor.formatOnPaste": true,
+    "editor.formatOnType": true
+  }
 }

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/accounting/Account.java

@@ -3,7 +3,6 @@
 import java.math.BigDecimal;
 import java.math.RoundingMode;
 import java.util.List;
-
 import lombok.Value;
 
 /**
@@ -25,8 +24,8 @@ public BigDecimal getItemTotalPrice() {
   }
 
   /**
-   * 税抜きの送料を取得します。 送料は会計アイテムの合計金額が 5,000 円以上で無料になります。 それ以外の場合 500 円です。 ただし、会計アイテムが登録されていない場合は 0
-   * 円を返します。
+   * 税抜きの送料を取得します。 送料は会計アイテムの合計金額が 5,000 円以上で無料になります。 それ以外の場合 500 円です。
+   * ただし、会計アイテムが登録されていない場合は 0 円を返します。
    * 
    * @return 送料
    */

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/accounting/AccountItem.java

@@ -1,10 +1,12 @@
 package com.dressca.applicationcore.accounting;
 
 import java.math.BigDecimal;
-
 import lombok.AllArgsConstructor;
 import lombok.Data;
 
+/**
+ * 会計情報のドメインモデルです。
+ */
 @Data
 @AllArgsConstructor
 public class AccountItem {

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/assets/AssetApplicationService.java

@@ -3,7 +3,6 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.core.io.Resource;
 import org.springframework.stereotype.Service;
-
 import lombok.AllArgsConstructor;
 
 /**
@@ -12,7 +11,7 @@
 @Service
 @AllArgsConstructor
 public class AssetApplicationService {
-  
+
   @Autowired
   private AssetRepository repository;
   @Autowired
@@ -30,7 +29,7 @@ public AssetResourceInfo getAssetResourceInfo(String assetCode) throws AssetNotF
         .orElseThrow(() -> new AssetNotFoundException(assetCode));
     Resource resource = this.store.getResource(asset)
         .orElseThrow(() -> new AssetNotFoundException(assetCode));
-    
+
     return new AssetResourceInfo(asset, resource);
   }
 }

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/assets/AssetNotFoundException.java

@@ -14,7 +14,7 @@ public class AssetNotFoundException extends LogicException {
    * @param assetCode 見つからなかった買い物かご Id
    */
   public AssetNotFoundException(String assetCode) {
-    super(null, ExceptionIdConstant.E_ASSET0001, new String[] {assetCode},
-        new String[] {assetCode});
+    super(null, ExceptionIdConstant.E_ASSET0001, new String[] { assetCode },
+        new String[] { assetCode });
   }
 }

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/assets/AssetRepository.java

@@ -6,7 +6,7 @@
  * アセットリポジトリ。
  */
 public interface AssetRepository {
-  
+
   /**
    * 指定したアセットコードの情報を取得します。
    * 存在しない場合は 空のOptional を返します。

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/assets/AssetResourceInfo.java

@@ -1,7 +1,6 @@
 package com.dressca.applicationcore.assets;
 
 import org.springframework.core.io.Resource;
-
 import lombok.Data;
 import lombok.NonNull;
 

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/assets/AssetStore.java

@@ -1,7 +1,6 @@
 package com.dressca.applicationcore.assets;
 
 import java.util.Optional;
-
 import org.springframework.core.io.Resource;
 
 /**

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/assets/AssetTypes.java

@@ -1,7 +1,6 @@
 package com.dressca.applicationcore.assets;
 
 import java.util.Set;
-
 import org.apache.commons.lang3.StringUtils;
 
 /**

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/baskets/Basket.java

@@ -5,14 +5,15 @@
 import java.util.List;
 import java.util.Optional;
 import java.util.stream.Collectors;
-
 import com.dressca.applicationcore.accounting.Account;
 import com.dressca.applicationcore.accounting.AccountItem;
-
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import lombok.NonNull;
 
+/**
+ * 買い物かごの情報を表現するドメインモデルです。
+ */
 @Data
 @NoArgsConstructor
 public class Basket {
@@ -24,7 +25,7 @@ public class Basket {
   public Basket(@NonNull String buyerId) {
     this.buyerId = buyerId;
   }
-  
+
   public Basket(long id, @NonNull String buyerId) {
     this.id = id;
     this.buyerId = buyerId;
@@ -34,12 +35,12 @@ public Basket(long id, @NonNull String buyerId) {
    * 商品を追加します。
    * 
    * @param catalogItemId カタログアイテムID
-   * @param unitPrice 単価
-   * @param quantity 数量
+   * @param unitPrice     単価
+   * @param quantity      数量
    */
   public void addItem(long catalogItemId, BigDecimal unitPrice, int quantity) {
-    Optional<BasketItem> existingItem =
-        this.items.stream().filter(item -> item.getCatalogItemId() == catalogItemId).findFirst();
+    Optional<BasketItem> existingItem = this.items.stream().filter(item -> item.getCatalogItemId() == catalogItemId)
+        .findFirst();
 
     existingItem.ifPresentOrElse(item -> item.addQuantity(quantity),
         () -> this.items.add(new BasketItem(0, id, catalogItemId, unitPrice, quantity)));

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/baskets/BasketApplicationService.java

@@ -2,11 +2,13 @@
 
 import java.math.BigDecimal;
 import java.util.Map;
-
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.stereotype.Service;
 import lombok.AllArgsConstructor;
 
+/**
+ * 買い物かご情報に関するビジネスユースケースを実現するサービスです。
+ */
 @Service
 @AllArgsConstructor
 public class BasketApplicationService {
@@ -15,10 +17,10 @@ public class BasketApplicationService {
   /**
    * 買い物かごに商品を追加します。
    * 
-   * @param basketId 買い物かごID
+   * @param basketId      買い物かごID
    * @param catalogItemId カタログ商品ID
-   * @param price 単価
-   * @param quantity 数量
+   * @param price         単価
+   * @param quantity      数量
    * @throws BasketNotFoundException 買い物かごが見つからなかった場合
    */
   public void addItemToBasket(long basketId, long catalogItemId, BigDecimal price, int quantity)
@@ -47,7 +49,7 @@ public void deleteBasket(long basketId) throws BasketNotFoundException {
   /**
    * 買い物かご内の商品の数量を設定します。
    * 
-   * @param basketId 買い物かごID
+   * @param basketId   買い物かごID
    * @param quantities キーにカタログ商品ID、値に数量を設定したMap
    * @throws BasketNotFoundException 買い物かごが見つからなかった場合
    */

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/baskets/BasketItem.java

@@ -1,12 +1,14 @@
 package com.dressca.applicationcore.baskets;
 
 import java.math.BigDecimal;
-
 import com.dressca.applicationcore.accounting.AccountItem;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
+/**
+ * 買い物かごアイテムのドメインモデルです。
+ */
 @Data
 @NoArgsConstructor
 @AllArgsConstructor

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/baskets/BasketNotFoundException.java

@@ -3,9 +3,12 @@
 import com.dressca.systemcommon.constant.ExceptionIdConstant;
 import com.dressca.systemcommon.exception.LogicException;
 
+/**
+ * 買い物かごが存在しないことを表す例外クラスです。
+ */
 public class BasketNotFoundException extends LogicException {
   public BasketNotFoundException(long basketId) {
-    super(null, ExceptionIdConstant.E_BASKET0001, new String[] {String.valueOf(basketId)},
-        new String[] {String.valueOf(basketId)});
+    super(null, ExceptionIdConstant.E_BASKET0001, new String[] { String.valueOf(basketId) },
+        new String[] { String.valueOf(basketId) });
   }
 }

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/baskets/BasketRepository.java

@@ -2,6 +2,9 @@
 
 import java.util.Optional;
 
+/**
+ * 買い物かごリポジトリ。
+ */
 public interface BasketRepository {
   Optional<Basket> findById(long id);
 

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/catalog/CatalogApplicationService.java

@@ -1,11 +1,12 @@
 package com.dressca.applicationcore.catalog;
 
 import java.util.List;
-
 import org.springframework.stereotype.Service;
-
 import lombok.AllArgsConstructor;
 
+/**
+ * カタログ情報に関するビジネスユースケースを実現するサービスです。
+ */
 @Service
 @AllArgsConstructor
 public class CatalogApplicationService {
@@ -16,10 +17,10 @@ public class CatalogApplicationService {
   /**
    * 条件に一致するカタログ情報を取得します。
    * 
-   * @param brandId ブランドID
+   * @param brandId    ブランドID
    * @param categoryId カテゴリID
-   * @param page ページ
-   * @param pageSize ページサイズ
+   * @param page       ページ
+   * @param pageSize   ページサイズ
    * @return 条件に一致するカタログ情報のリスト。存在しない場合は空のリスト。
    */
   public List<CatalogItem> getCatalogItems(long brandId, long categoryId, int page, int pageSize) {
@@ -29,7 +30,7 @@ public List<CatalogItem> getCatalogItems(long brandId, long categoryId, int page
   /**
    * 条件に一致するカテゴリの件数を取得します。
    * 
-   * @param brandId ブランドID
+   * @param brandId    ブランドID
    * @param categoryId カテゴリID
    * @return 条件に一致するカタログ情報の件数。
    */

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/catalog/CatalogBrand.java

@@ -2,7 +2,6 @@
 
 import java.util.ArrayList;
 import java.util.List;
-
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import lombok.NonNull;

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/catalog/CatalogBrandRepository.java

@@ -8,6 +8,7 @@
 public interface CatalogBrandRepository {
   /**
    * すべてのカタログブランドを取得します。
+   * 
    * @return カタログブランドのリスト
    */
   List<CatalogBrand> getAll();

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/catalog/CatalogCategory.java

@@ -1,7 +1,6 @@
 package com.dressca.applicationcore.catalog;
 
 import java.util.List;
-
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import lombok.NonNull;
@@ -16,7 +15,7 @@ public class CatalogCategory {
   @NonNull
   private String name;
   private List<CatalogItem> items = List.of();
-  
+
   public CatalogCategory(@NonNull String name) {
     this.name = name;
   }

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/catalog/CatalogCategoryRepository.java

@@ -8,6 +8,7 @@
 public interface CatalogCategoryRepository {
   /**
    * すべてのカタログカテゴリを取得します。
+   * 
    * @return カタログカテゴリのリスト
    */
   List<CatalogCategory> getAll();

samples/web-csr/dressca-backend/application-core/src/main/java/com/dressca/applicationcore/catalog/CatalogDomainService.java

@@ -2,9 +2,7 @@
 
 import java.util.List;
 import java.util.stream.Collectors;
-
 import org.springframework.stereotype.Service;
-
 import lombok.AllArgsConstructor;
 
 /**
@@ -17,7 +15,8 @@ public class CatalogDomainService {
 
   /**
    * 指定したカタログアイテム Id のうち、存在するカタログアイテムの一覧を返却します。
-   * @param catalogItemIds カタログアイテム Id のリスト 
+   * 
+   * @param catalogItemIds カタログアイテム Id のリスト
    * @return 存在するカタログアイテムの一覧
    */
   public List<CatalogItem> getExistCatalogItems(List<Long> catalogItemIds) {
@@ -26,6 +25,7 @@ public List<CatalogItem> getExistCatalogItems(List<Long> catalogItemIds) {
 
   /**
    * 指定したカタログアイテム Id がリポジトリ内にすべて存在するかを取得します。
+   * 
    * @param catalogItemIds カタログアイテム Id のリスト
    * @return すべて存在する場合は true、一部でも不在の場合は false。
    */
@@ -34,7 +34,7 @@ public boolean existAll(List<Long> catalogItemIds) {
     List<Long> notExistCatalogItemIds = catalogItemIds.stream()
         .filter(catalogItemId -> !this.existCatalogItemIdInItems(items, catalogItemId))
         .collect(Collectors.toList());
-    
+
     return notExistCatalogItemIds.isEmpty();
   }