キーに文字列を代入する意味

Question

（環境）
xcode:11.3
version 5.1.3

（参考文献）
詳解　Swift 第５版
著者　萩原剛志
発行者 SBクリエイティブジャブ式会社

上記の参考文献からSwiftを学んでおります。下記に秒数をカウントダウンしてcountDownLabelに残秒数を表示させるサンプルコードで一点わからない点があります。

let settingKey = "timer_value" //ここです
の定数の宣言なのですが、ここでsettingKeyの定数に文字列の"timer_value"を代入することに何か意味があるのでしょうか？
settings.register(defaults: [settingKey:10])やlet timerValue = settings.integer(forKey: settingKey)で初期値として１０を登録したり取り出したりする際に、実際にはsettingKeyをキー（ラベル）の様な使い方をしており、特に何かの文字列を代入することに意味がない様に思えるのですが、文法的な意味合いがわかればご教示いただけると嬉しいです。

import UIKit

class ViewController: UIViewController {
    
    var timer : Timer?
    var count = 0
    let settingKey = "timer_value" //ここです

    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view.
        let settings = UserDefaults.standard
        settings.register(defaults: [settingKey:10])
    }

    @IBOutlet weak var countDownLabel: UILabel!
    
    
    @IBAction func settingButtonAction(_ sender: Any) {
        // timerをアンラップしてnowTimerに代入
              if let nowTimer = timer {
                  // もしタイマーが、実行中だったら停止
                  if nowTimer.isValid == true {
                      // タイマー停止
                      nowTimer.invalidate()
                  }
              }
              // 画面遷移を行う
              performSegue(withIdentifier: "goSetting", sender: nil)
    }
    
    @IBAction func startButtonAction(_ sender: Any) {
        // timerをアンラップしてnowTimerに代入
         if let nowTimer = timer {
             // もしタイマーが、実行中だったらスタートしない
             if nowTimer.isValid == true {
                 // 何も処理しない
                 return
             }
         }
         
         // タイマーをスタート
         timer = Timer.scheduledTimer(timeInterval: 1.0,
                                      target: self,
                                      selector: #selector(self.timerInterrupt(_:)),//ここです
                                      userInfo: nil,
                                      repeats: true)
        
    }
    
    @IBAction func stopButtonAction(_ sender: Any) {
        // timerをアンラップしてnowTimerに代入
         if let nowTimer = timer {
             // もしタイマーが、実行中だったら停止
             if nowTimer.isValid == true {
                 // タイマー停止
                 nowTimer.invalidate()
             }
         }
    }
    
    func displayUpdate() -> Int {
          
          // UserDefaultsのインスタンスを生成
          let settings = UserDefaults.standard
          // 取得した秒数をtimerValueに渡す
          let timerValue = settings.integer(forKey: settingKey)
          // 残り時間(remainCount)を生成
          let remainCount = timerValue - count
          // remainCount(残りの時間)をラベルに表示
          countDownLabel.text = "残り(remainCount)秒"
          // 残り時間を戻り値に設定
          return remainCount

      }
      
      // 経過時間の処理
      @objc func timerInterrupt(_ timer:Timer) {
          
          // count(経過時間)に+1していく
          count += 1
          // remainCount(残り時間)が0以下のとき、タイマーを止める
          if displayUpdate() <= 0 {
              // 初期化処理
              count = 0
              // タイマー停止
              timer.invalidate()
          }
      }
        
    override func viewDidAppear(_ animated: Bool) {
           // カウント(経過時間)をゼロにする
           count = 0
           // タイマーの表示を更新する
           _ = displayUpdate()
       }
    
    
}

Comments

[MasakiHori]

質問は1ずつ行ったほうが回答を得やすいです

[pegy]

コメントいただきありがとうございます。
質問を分けて投稿させていただきます。
よろしくお願い申し上げます。

Answer 1

回答を修正/変更

---

UserDefaultsは「辞書」と呼ばれる構造を持ったクラスです。
辞書は二つの値を持つペアを複数持った構造です。
ややこしいですがSwiftのDictionayも辞書構造をもつstructです。

辞書は文字通り索引（項目名）とその内容を持った構造で、索引から内容を取得するものです。
この索引に当たるものをKeyと呼びます。取り出した値はそのままValueです。

UserDefaultsはキーとして文字列を使用することとなっています。
つまり"timer_value"は辞書のキーということになります。
もちろん別のキーを使うと全く無関係の値を登録することが出来ます。

またUserDefaultsにはデータを永続化（アプリを終了した後でも前回のデータを記憶）する機能も備わっていますので、このような場面でよく使われます。

なおUserDefaultsは大容量のデータを永続化することを想定していないクラスですので、何でもかんでもUserDefaultsを使うのはやめましょう。

---

質問の意図とずれているかもしれませんが、typo（入力間違い）によるバグを発生させにくくしたり、変更/修正を容易にするためです。

定数に代入することなく直接文字列を書けばいいのですが、そうすると、文字列の間違いをコンパイラは検出できないため、typoによるバグが発生する温床になります。

また、文字列を変更/修正する必要が生じた時、定数を利用していなければ、すべての対象文字列を確実に変更/修正しなければなりません。
これもバグの温床となります。
定数に代入して利用していれば、変更は1か所のみとなります。

このような理由で、文字列を使いたい場合は定数に代入しそれを利用するようにします。

※ 例外はあります
ex. fatalErrorの引数とか

Comments

[pegy]

コメント頂き有難うございます。変数化又は定数化する事でバクを未然に防止するという趣旨を理解致しました。
そういう意味では"timer_value"自体にはあまり意味はなく

let settingKey: String?
だけの宣言でも良い気がするのですが、如何でしょうか？
"timer_value"という文字列が何も使われていないことへの不思議に囚われすぎているのかもしれません。。
重ねて申し訳ございませんが、宜しくお願い申し上げます。

[MasakiHori]

そちらの疑問でしたか
回答変更します

[pegy]

コメント改めてありがとうございます。
dictionaryという構造を持つクラスであることはわかり、どの様な型であるのか参考書で確認しました。
どうしても納得できない部分があるのですが。
settings.register(defaults: [settingKey:10])として
最終的には永続的にアクセスしたいのデータは10という数値であり
let settingKey = "timer_value"
defaults: [settingKey:10]
の繋がりが見えづらく、ここで任意の文字列"timer_value"の存在が任意のどの値を入れてもどうせ使わないのにと思ってしまいます。

結局数値の10アクセスするためには[settingKey:10]であれば足りると思っており
頭の中の構造では↓の様なイメージでおります。
let userDefaults: Dictionary<String, Int> = ["settingKey": 10]

おそらく何か根本的な勘違いをしているのかもしれませんが、ご指摘願えますでしょうか。

[pegy]

辞書のキーであるとすると、実際には
["timer_value": 10]
ということではあるが、これを定数かして汎用的に使用することと、冒頭おっしゃっていたバグの温床を回避する目的で
settingKey = "timer_value"
に置き換えて使用しているという解釈で正しいでしょうか？

[MasakiHori]

最初に起動したときにはsettingKeyに対応する値は存在していません。
しかし、settings.register(defaults: [settingKey:10])のようにしておくと値が存在しなかった時にここで登録した値が返されるようになります。
ここはそのためのコードです。

おそらく読み進めるとユーザーが任意の秒数に変更できるようにするのだと思いますが、この時 10 を定数としておくとその対応が出来ません。
UserDefaultsを使っていればユーザーが任意に秒数を変更した時にその値をUserDefaultsに保存することで、ユーザーが指定した秒数で動くようになります。

[pegy]

ありがとうございます。あまりうまくお伝えできずに申し訳ないでのですが、
おっしゃる流れな概ね理解することができました。また動作としてもご推察の通りなのですが、そのご説明の過程でも一度もtimer_valueは出てこないと思います。

[settingKey:10]であれば足りるので

なぜ、↓の様に使いもしない文字列をキーの値に代入しているのでしょうか？
settingKey = "timer_value"

実際にキーとして呼び出しをする時も
let timerValue = settings.integer(forKey: settingKey)

なので、settingKey = "timer_value"のコードが意味がないのではと思っています。結局、辞書型のクラスから呼び出すときのキーはsettingKeyなのですよね？なぜこのコードは、その後、利用されることもない、任意の"timer_value"を代入してみようと思ってのでしょうか？

[pegy]

例えばJavascriptのオブジェクトを作るとき

const obj = {
color: "red"
getColor:function(){
return "色:" + this.color;
}
}
の様に作りますが、

[pegy]

感覚的にですが
settingKey = "timer_value"
の様に
let color = "color_value";
の様にキーになるものに文字列を代入すことはしないです。あまり、10を呼び出すためのキーはあくまでcolor.なのでとても不思議です。

上記のSwiftのコードでもsettingKey:10が成り立っているのにあえて
settingKey = "timer_value"
としてあげるところが不思議なのです。
コンパイル型特有の記法であれば勉強不足かもしれません。
細かい点で本当に申し訳ございません。

[MasakiHori]

なるほどわかりました。　あなたは定数というものを正しく理解できていません。
これは辞書の話と似た話で、定数は値にラベルをつけたものです。
ラベルだけでは意味を成しません
settingKeyの部分はすべて"timer_value"のことです

let settingKey = "timer_value"
としたことで本来
settings.register(defaults: ["timer_value":10])
と書かなければならないものが
settings.register(defaults: [settingKey:10])
と書けるということです。
他でsettingKeyを使っている部分も同様です。

typoのバグというのは、定数名のsettingKeyのスペルを間違えてしまっていてもコンパイラがエラーを発生させるので間違いに気づけますが、文字列内 timer_value のスペルを間違えていてもコンパイラはエラーを発生させない。つまりtypo/スペルミスでバグが発生してしまうということです。

[MasakiHori]

typoの可能性がある文字列を何度も書くのをやめて、typoがあってもコンパイラによって間違いが気付ける定数を利用しているということです

[pegy]

なるほど、大変よくわかりました。
逆に色々と混乱させてしまい、申し訳ございません。こころからお詫び申し上げます。
コンパイル言語では一般的な書き方（定数を使用することが）なのかもしれませんが、これに慣れていこうと思います。また、これからコードを書き進める中でなるほどと思える局面が出てくるとも思いますので、ご質問できてよかったです。

最後までお使いをいただいたことについて、改めてお詫びと御礼を申し上げます。
よろしくお願い申し上げます。