🤯

環境変数ってなんや！JSONってなんや！

2024/04/06に公開

Python

はじめに

以前、私が書いた記事を読んでくれた友人から次のような感想をいただきました。

トークンやチャンネルIDを直接プログラムに記述するべきではない
環境変数やJSONなどに設定して読み込ませるべき
Git使う時とかにトークンとかそのまま上げたらまずいよ

確かにそうかもしれない⋯
でも、環境変数ってなんや！JSONってなんや！全くわからん！🤯

環境変数ってなんや？

Wikipediaによると、次のように説明されていました。

環境変数（かんきょうへんすう、英語: environment variable）はオペレーティングシステム (OS) が提供するデータ共有機能の一つ。OS上で動作するタスク（プロセス）がデータを共有するための仕組みである。特にタスクに対して外部からデータを与え、タスクの挙動・設定を変更するために用いる。

どうやら、環境変数として保存しておけば、すべてのプログラムでその値を使うことができるようです。（普段、何気なく通してるPATHとかもその一種らしい。）
プログラムの外（PC本体など）に定義できる変数ってイメージがわかりやすそう（？）

環境変数使ってみた

試しにPythonで環境変数を使ってみました。

以下の記事で紹介しているLINE.pyに記載していたLINE Notifyのアクセストークンを環境変数として設定してみます。

LINE.py

# requestsモジュールのインポート
import requests

# 送信するメッセージを定義
linemsg = 'xxxxxxxx' # 送信したいメッセージに置き換えてください

# LINE Notifyのアクセストークンを定義
token = "xxxxxxxx" # アクセストークンに置き換えてください

#LINEメッセージ送信の関数
def LINE_message(msg):
  # APIエンドポイントのURLを定義
  url = "https://notify-api.line.me/api/notify"
  # HTTPリクエストヘッダーの設定 
  headers = {"Authorization" : "Bearer "+ token}
  # 送信するメッセージの設定
  message =  (msg)
  # ペイロードの設定
  payload = {"message" :  message}
  # POSTリクエストの使用 
  r = requests.post(url, headers = headers, params=payload)

# 関数の呼び出し
LINE_message(linemsg)

動作環境

Macbook Air M1
MacOS Sonoma 14.4.1
Python 3.9.6

python-dotenv

今回は、Pythonプロジェクトで環境変数を管理するためのライブラリであるpython-dotenvを使用してみます。
まず、環境変数を保存するための.envというファイルを作成し、その中に環境変数を記述します。その後、プログラム内でpython-dotenvを使用して.envファイルから環境変数を取得します。

モジュールがインストールされていない場合は、以下のコマンドを実行してpython-dotenvをインストールしましょう。

pip3 install python-dotenv

.envファイルは、作業ディレクトリ内で以下のコマンドを実行することで作成できます。

touch .env

私が作成した.envファイルは隠しファイルになっていました。セキュリティ上の観点からこのようになっているのかもしれません。

そして、.envファイル内に次のように書き込みました。

.env

LINE_NOTIFY_TOKEN='xxxxxxxxxxxxxxxxxx'

.envファイルは、一行に一つの環境変数を変数名=値の形式で記述することができます。

そして、LINE.pyを.envファイルから環境変数を取得するように変更しました。

.envファイルから環境変数を取得するように変更したLINE.py

LINE.py

import os
from dotenv import load_dotenv

# .envファイルから環境変数を取得する
load_dotenv()

# requestsモジュールのインポート
import requests

# 送信するメッセージを定義
linemsg = '環境変数！'

# LINE Notifyのアクセストークンを取得
token = os.environ['LINE_NOTIFY_TOKEN']

#LINEメッセージ送信の関数
def LINE_message(msg):
  # APIエンドポイントのURLを定義
  url = "https://notify-api.line.me/api/notify"
  # HTTPリクエストヘッダーの設定 
  headers = {"Authorization" : "Bearer "+ token}
  # 送信するメッセージの設定
  message =  (msg)
  # ペイロードの設定
  payload = {"message" :  message}
  # POSTリクエストの使用 
  r = requests.post(url, headers = headers, params=payload)

# 関数の呼び出し
LINE_message(linemsg)

load_dotenv()で.envファイルから環境変数を取得し、os.environ[環境変数名]で指定した環境変数を呼び出します。

このプログラムを実行すると正しく動作したことから、LINE Notifyのアクセストークンを正確に取得できていることがわかりました。

これにより、.envを使った環境変数の管理について理解を深めることができました。
セキュリティ上の理由から、秘密情報を含む場合には.envファイルを適切に保護する必要があるでしょう。（Gitを用いる際に、.gitignoreに追加するなど！）

JSONってなんや？

Wikipediaによると、次のように説明されていました。

JavaScript Object Notation（JSON、ジェイソン）はデータ記述言語の1つである。軽量なテキストベースのデータ交換用フォーマットでありプログラミング言語を問わず利用できる^[1]。名称と構文はJavaScriptにおけるオブジェクトの表記法に由来する。

JSONは元々、JavaScript由来のデータ記述言語であり、JSONファイル内に環境変数などのデータを記述することで、プログラムが実行される環境に依存しないようにできるようです。
つまり、大まかな役割は先ほどの.envと同様というように見えますが、JSONファイルは環境変数以外にも、汎用的なデータの保存に使用され、データの構造化や交換に適しているという特徴があるようです。

JSON使ってみた

先ほどと同様にして、LINE.pyに記載していたLINE Notifyのアクセストークンを環境変数としてJSONファイルに設定してみます。

動作環境

動作環境は、python-dotenvの時と同様です。

JSONファイル

JSONファイルは、作業ディレクトリ内で以下のコマンドを実行することで作成できます。

touch example.json

これにより、example.jsonという名前の空のJSONファイルが作成されます。
そして、このファイル内に次のように書き込みました。

example.json

{
    "LINE_NOTIFY_TOKEN": "xxxxxxxxxxxxxxxxxx"
}

Pythonの辞書に似た見た目の構造でデータを格納することができました。（あくまでも見た目が似ているだけで、全くの別物のようですが。）

そして、LINE.pyをJSONファイルから環境変数を取得するように変更しました。

example.jsonから環境変数を取得するように変更したLINE.py

LINE.py

# requestsモジュールのインポート
import requests

# 送信するメッセージを定義
linemsg = 'JSONだよ！'

import json

# example.jsonファイルからLINE_NOTIFY_TOKENを読み込む
with open('example.json', 'r') as json_file:
    data = json.load(json_file)
    token = data.get('LINE_NOTIFY_TOKEN')

# LINE_NOTIFY_TOKENが取得できたか確認
if token:
    print("LINE_NOTIFY_TOKEN:", token)
else:
    print("LINE_NOTIFY_TOKENが見つかりませんでした。")

#LINEメッセージ送信の関数
def LINE_message(msg):
  # APIエンドポイントのURLを定義
  url = "https://notify-api.line.me/api/notify"
  # HTTPリクエストヘッダーの設定 
  headers = {"Authorization" : "Bearer "+ token}
  # 送信するメッセージの設定
  message =  (msg)
  # ペイロードの設定
  payload = {"message" :  message}
  # POSTリクエストの使用 
  r = requests.post(url, headers = headers, params=payload)

# 関数の呼び出し
LINE_message(linemsg)