リクエスト

json形式でリクエストを受取ります。※ 認証機能は入れてないのでuser_idもリクエストに入れてます。

コントローラーに@RequestMappingのproducesを設定してjsonでリクエストを受取ることを明示します。
メソッド引数に@RequestBodyを付けて受け取る形をクラスで指定します。

@RestController
@RequestMapping(produces = MediaType.APPLICATION_JSON_VALUE)
public class GachaController {

	@Autowired
	private GachaServiceFacade gachaServiceFacade;

	@PostMapping("/api/get")
	@CrossOrigin
	public List<CharacterDTO> playGacha(
			@RequestBody UserGachaCommand command) {
		return gachaServiceFacade.playGacha(command.getUser_id(),command.getType());
	}

UserGachaCommandはシンプルですがアクセサメソッドは付与しておきます

@Getter
@Setter
public class UserAddGachaCommand implements Serializable {

    private static final long serialVersionUID = 1L;

    private int user_id;

    private int amt;
}

エラーハンドリング

エラーが起きたとき（今回のケースではガチャ石が足りない時）には処理を中断してエラーメッセージを返却しています。

以下の手順でエラーハンドリングを行っています

@RestControllerAdviceを付与したクラスを作成する
- ResponseEntityExceptionHandlerを継承する
- @ExceptionHandlerに対象とするクラスを指定するメソッドの作成戻り値はMapにする(簡単にする場合)
  - 戻り値はMapにする(簡単にする場合)
対象クラスはRuntimeExceptionを継承する
対象クラスをスローする

以下の場合はNotEnoughExceptionがスローされた時に、errorMapが返却されます。NotEnoughExceptionクラスはスローさえできればいいので実装は不要です。

@RestControllerAdvice(annotations = RestController.class)
public class ApiExceptionHandler extends ResponseEntityExceptionHandler {
    // 個別のカスタムエラークラスをハンドリングする
    @ExceptionHandler(NotEnoughException.class)
    public Map<String, Object> handleNotEnoughException(
            Exception ex, WebRequest webRequest
    ){
        Map<String, Object> errorMap = new HashMap<String, Object>();
        errorMap.put("message", "ガチャ石が足りません。");
        return errorMap;
    }
}

レスポンス

DTOクラスを用意して、それを返却すれば自動的にjson形式で扱えました。ただしゲッターメソッドは必須です

@AllArgsConstructor
@Getter
/**
 * クラスをJSONとして返却する際には、Getterが必要になります。
 */
public final class CharacterDTO {

	private final int lank;

	private final String name;

	private final String url;

}

データアクセスには@Entityアノテーションを持ったクラスを容易しています。これらはメソッドもあるのでDTOに変換してgetterのみを持ったオブジェクトにします。

@javax.persistence.Entity
@Table(name="userdatas")
@Getter
@Setter
public class UserData implements Entity<UserData> {

    @Column(name = "id")
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private int id;

    @Id
    @Column(name = "user_id")
    private int user_id;

    @Embedded
    private Stone stone;

    /**
     * ガチャ石がマイナスにならない場合はガチャ石を使用します
     *
     * @param sub
     * @return
     */
    public boolean useStone(int sub){
        if(this.stone.canGacha(sub)){
            this.stone = this.stone.sub(sub);
            return true;
        }
        return false;
    }

    public UserData addStone(int amt){
        this.stone = this.stone.add(amt);
        return this;
    }

    public int getStoneAmt(){
        return this.stone.getAmt();
    }

}

DTO

@AllArgsConstructor
@Getter
public final class UserDataDTO {
    private int amt;
}

MapperクラスはModelMapperなど使わずに作りました

public class UserDataDTOMapper {

    public UserDataDTO toDTO(UserData userData){
        return new UserDataDTO(userData.getStoneAmt());
    }

}

ちなみにリストはstreamを使うとあっさり書けます

public class CharacterDTOMapper {

    public CharacterDTO toDTO(Character character){
        return new CharacterDTO(character.getLank(),character.getName(), character.getUrl());
    }

    public List<CharacterDTO> toDTOList(List<Character> characters){
        return characters.stream().map(this::toDTO).collect(Collectors.toList());
    }
    
}

データベース

データベースはdockerで用意しています。別途記事があるのでそのまんまです

リンク

余談

なんか最近プログラミングの吸収力が上がった気がします(気がしてるだけです)以下の原因が考えられると思う（根拠はないので感覚です）

デザインパターンについて考えた
- 実際にサンプルをいくつか自分で作る
他人のソースをコードリーディングした
- 自分なりに改造して動かす
- 何が起きてるのかまとめる

参考にしていた本とURL

オブジェクト指向のこころ
オブジェクト指向における再利用のためのデザインパターン
ddd-java
dddsample

オブジェクト指向のこころとかは古いソースになってしまいますが、デザインパターンとかの裏側を知るにはとても良いと思います。

Spring boot でAPI開発