このような方に向けて書きました。

スマホアプリは無料で簡単に入れられるので、気づいたら50個・100個と増えていることがあります。

でも、アプリが多ければ多いほど良いわけではありません。増えすぎたアプリには、見えないコストがかかっています。

僕はミニマリスト思考でスマホを整理した結果、今は13個のアプリだけで快適に暮らせています。

この記事では、アプリを断捨離する具体的な手順と判断基準、そして僕が実際に残した13個のアプリを全公開します。

アプリを断捨離すべき理由

「アプリは無料だし、入れておいても損はないでしょ？」と思いがちです。

でも実際には、アプリが増えるほど次のようなデメリットが積み重なります。

バックグラウンド通信で通信量が増える

使っていないアプリでも、バックグラウンドで通信を続けているものがあります。

通知を受け取るためや、データを同期するためです。

アプリを減らすだけで月々の通信量が減り、スマホプランを安いプランに変えられる可能性があります。

年換算すると数千円〜1万円以上の節約になるケースも。

ストレージを圧迫してスマホ本体が高くなる

アプリそのものはもちろん、キャッシュデータもストレージを消費します。

「256GBじゃないと足りない」と思って高いモデルを買ったけど、アプリを断捨離したら128GBで十分だった、という話はよくあります。

スマホ本体の選び方にも影響するんです。

必要なアプリを探せなくなる

アプリが増えると、ホーム画面がアイコンだらけになります。

使いたいアプリをすぐに開けない、という地味なストレスが積み重なります。

僕はアプリを絞り込んでから、「あのアプリどこだっけ？」と探す時間がゼロになりました。

小さなことですが、毎日積み重なると結構違います。

スマホアプリを断捨離する手順

アプリの断捨離は「どれを残すか」から考えると迷います。

おすすめは逆の発想、「全部消してから、必要なものだけ入れ直す」やり方です。

ステップ1：削除できるアプリを全部消す

まずはシステムアプリ（消せないもの）以外を、思い切ってすべて削除します。

「もしかしたら使うかも」というアプリは、その「もしかしたら」がほぼ来ません。

アプリはいつでも再インストールできるので、迷ったら消す方針でいきましょう。

ステップ2：1週間使って必要なものだけ入れ直す

消した後、日常生活の中で「このアプリが必要だ」と思った瞬間にだけ入れ直します。

1週間やってみると、本当に必要なアプリは思った以上に少ないことに気づきます。

「なんとなく入れていた」アプリがいかに多かったかが実感できます。

ステップ3：残すアプリの判断基準を持つ

入れ直すアプリを判断するときの基準はシンプルです。

「週1回以上使うか」が一番シンプルで使いやすい基準です。

これだけで大半のアプリは自然と絞れます。

消してよかったアプリのカテゴリ

参考までに、僕が断捨離して「消してよかった」と感じたカテゴリを紹介します。

毎日使う基本アプリ5選

これがないと生活が成り立たない、インストール必須のアプリたちです。

1Password

1Passwordは「ログイン情報」や「銀行口座」などの機密情報を管理するアプリです。

年会費4,000円ほどかかりますが、メリットだらけで手放せなくなりました。

パスワードを忘れてあたふたする時間が消えます。

もはや必須ツールです。

1Password – Password Manager

AgileBits Inc.無料posted withアプリーチ

Claude

どんな質問にも、相談にも答えてくれる「相棒」のような存在です。

最近ではインターネット上から最新の情報を拾ってきたり、より詳細な会話もできるようになりました。

僕はちょっと神経を使うメールのやり取りや、精神的にしんどい時の相談役として使っています。

月額20ドルかかりますが、月給20ドルの社員を雇ったつもりで使っています。

Claude by Anthropic

Anthropic PBC無料posted withアプリーチ

Google Maps

普段の移動はもちろん、旅行時にも目的地が一瞬で検索できます。

「どこかいい飲食店ないかなぁ」という時もマップを開けば評判の良いお店が出てきます。「場所」に関する悩みはすべて叶えてくれるアプリです。

Google マップ – 乗換案内 & グルメ

Google無料posted withアプリーチ

乗換案内

電車やバスの情報はこれ一本でいけます。

Google Mapsでも乗り換え検索はできますが、まだこのアプリには敵わないという印象です。

乗換案内

Jorudan Co.,Ltd.無料posted withアプリーチ

Amazon

ネットショッピングはほとんどAmazonです。Prime会員なので送料無料ですぐ届くのが魅力。

あまりにすぐ届くので、配送スタッフさんのことが心配になってしまうほどです。

Amazon ショッピングアプリ

AMZN Mobile LLC無料posted withアプリーチ

娯楽・情報収集に使うエンタメアプリ3選

気を抜くと仕事漬けの毎日になってしまうので、息抜きも大切にしています。

アプリが増えると管理が面倒になるので、少数精鋭で運用しています。

YouTube

「娯楽」と言いつつも、主に情報収集用として使っています。

家電はもちろん日用品なども、たいていの優れた情報はYouTubeに集まっている気がしており、頼りになる情報源です。

YouTube

Google無料posted withアプリーチ

YouTube Music

新旧・邦楽洋楽問わず、様々な音楽が視聴できます。「久々にあの曲が聴きたいな」という時にすぐ開けるのが便利です。

Amazon Primeに加入していれば無料で使えます。

YouTube Music

Google無料posted withアプリーチ

Amazon Prime Video

よくアニメの視聴用に使っています。

出社前にスマホにダウンロードしておき、電車内で観るのが日課です。

Amazon Prime Video

AMZN Mobile LLC無料posted withアプリーチ

スマホ一本でお金を管理する5個のアプリ

基本的にはスマホ決済・スマホ管理に一本化していて、家計簿も自動作成されるようにしています。

MoneyForward

家計簿アプリはMoneyForwardを使っています。収入・支出の項目が一目でわかるので、家計管理はこれ一つで完結します。

家計簿を作る時間を、別の作業に当てられます。

家計簿マネーフォワード ME – 人気の家計簿(かけいぼ)

Money Forward, Inc.無料posted withアプリーチ

楽天銀行

銀行口座は楽天銀行に一本化しました。

以前はかなり多くの口座を持っていましたが、こちらの記事で解説した通りすべて廃止しました。

楽天銀行は条件達成で「ATM引き出し手数料」や「振込手数料」が無料になるので、最近では銀行に手数料を支払った覚えがありません。

楽天銀行

楽天銀行株式会社無料posted withアプリーチ

楽天ペイ

バーコード決済は楽天ペイ1本に絞りました。PayPay・d払い・au Payと複数入れていた時期もありましたが、今は楽天ペイだけです。

期間限定ポイントや楽天キャッシュを使いきれない場合に消化するのがメインの用途です。

楽天ペイ-楽天ポイントカードも利用できるスマホ決済アプリ

Rakuten Group, Inc.無料posted withアプリーチ

メルカリ

ミニマリストの断捨離に欠かせないフリマアプリです。

ラクマよりユーザーが多いのか、すぐに高く売れます。不用品の出品用としては最高のアプリです。

フリマアプリはメルカリ – メルペイのスマホ決済でもっとお得

Mercari, Inc.無料posted withアプリーチ

マイナポータル

確定申告のe-Taxで年に一度使っています。

ふるさと納税をする方や副業をする方は入れておいて損はないと思います。

マイナポータル

デジタル庁無料posted withアプリーチ

まとめ：アプリを断捨離すると、スマホが道具に戻る

断捨離して残ったのは13個。

「少なすぎでは？」と思う方もいるかもしれませんが、実際にやってみると本当に快適です。

アプリが減ると、スマホが「なんとなく触ってしまう機械」から「必要な時に使う道具」に変わります。

まずはアプリを削除してみて、どれだけ身軽になれるかを試してみてください。

このような方に向けて書きました。

僕は5年前に長財布をやめ、カードが5枚ほどしか入らない小型の二つ折り財布に乗り換えました。

決済はApple Payとクレジットカード中心。現金はほぼ使わない生活です。

この記事では、財布を小さくしたきっかけから、今の決済構成、実際にやってみてわかったことまで、5年間のリアルをまとめます。

長財布をやめたきっかけ

「かさばる」という小さなストレス

長財布をやめた理由は、シンプルに「かさばるから」です。

ちょっとしたお出かけに小さめのバッグを使いたいとき、長財布がどうしても入らない。

かといってバッグを大きなものに変えるのも嫌で、「財布のせいで持ち物全体が制限される」という地味なストレスが積み重なっていました。

「長財布は運気が上がる」は本当か

「長財布はお金が貯まる」「運気が上がる」という話、聞いたことがある方も多いと思います。

僕も気になってはいました。でも実際のところ、財布の形よりも家計管理の仕組みの方がよほど大事だと感じています。

長財布を使っていた頃の方が、レシートとポイントカードで財布がパンパンで、むしろお金の流れが把握できていませんでした。

今の決済構成はこれだけ

財布を小さくすると同時に、決済の仕組みも整理しました。今の構成はシンプルです。

メインはApple Pay（クレジットカード）

コンビニ・スーパー・飲食店など、日常の支払いのほとんどはApple Payで完結します。

スマホをかざすだけで支払いが終わるので、財布を取り出す手間がありません。

クレジットカードはMoneyForwardと連携しているので、使った金額が自動的に家計簿に記録されます。レシートを管理する必要がないのが特に助かっています。

楽天ポイントだけは例外的に貯める

ポイントカードは全廃しましたが、楽天ポイントだけは例外にしています。

理由は、楽天ポイントが投資信託や普段の買い物にそのまま使えるから。

楽天市場・楽天ペイ・楽天銀行をまとめて使うことで、日常的にまとまったポイントが貯まります。「ポイ活」として頑張るわけではなく、使うサービスを楽天に寄せているだけで自然と貯まる感覚です。

楽天ペイが使える店舗ではできるだけ楽天ペイで支払い、期間限定ポイントや楽天キャッシュを消化するのがメインの使い方です。

現金は「最低限だけ」と割り切る

完全にキャッシュレスにはしていません。現金が必要な場面は確実にあるからです。

小型財布に少量のお札と小銭を入れて持ち歩いています。

現金が必要な場面と現実的な対処法

完全キャッシュレスは難しい場面がある

「現金いらない生活」に憧れる気持ちはありますが、現実的にはまだ現金が必要な場面があります。

僕の場合、よく行く銭湯が現金オンリーです。

あとは下駄箱やロッカーの鍵。100円玉を入れないと使えないタイプのものは、スマホ決済では対応できません。

100円玉を数枚持ち歩けば十分

対策はシンプルで、小銭入れに100円玉を数枚ストックしておくだけです。

「現金が必要になったらどうしよう」と不安に思いがちですが、実際に必要になる金額は限られています。

大きな買い物は基本的にキャッシュレスで対応できるので、財布の中に万円札を何枚も持ち歩く必要はありません。

財布を小さくしてよかった3つのこと

1. 持ち運びが圧倒的に楽になった

一番の変化は、バッグ選びの自由度が上がったことです。

以前は「長財布が入るバッグ」という制約がありましたが、今は小型財布がどんなバッグにも入るので選択肢が広がりました。

ちょっとしたお出かけに小さいトートやサコッシュを使いたいときも、財布のことを気にしなくてよくなりました。

2. ポイントカードという「義務感」がなくなった

長財布を使っていた頃は、ポイントカードが10枚以上入っていました。

財布が小さくなると、物理的に入らないのでポイントカードを自然に断捨離できます。

「このカード持ってますか？」と聞かれるたびに「持っていません」と答えるだけでよくなりました。レジでカードを探してモタつくこともなくなりました。

3. 家計管理が自動化された

現金払いが減ったことで、支出のほぼすべてがクレジットカードの明細に集約されるようになりました。

MoneyForwardと連携しているので、家計簿は自動で作成されます。

「先月いくら使ったっけ？」という疑問がアプリを開けば一瞬でわかるようになり、家計管理の精度が大幅に上がりました。

小さくする前に不安だったこと→実際はどうだったか

お札を折らなきゃいけない問題

二つ折り財布に変える前に一番気になっていたのが、お札を折る必要があること。

「きっちり折り畳まないといけないのは面倒では？」と思っていましたが、実際には問題ありませんでした。

ふんわり入れられるゆとりのある財布を選んだので、きっちり折らなくても自然に収まります。現金をほとんど使わなくなってからは、そもそもお札を出し入れする頻度自体が減りました。

小銭が入らない問題

「小銭が溜まったらどうするの？」という不安もありました。

実際にはキャッシュレス決済を使うようになってから、そもそもおつりをもらう機会がほとんどなくなりました。

小銭が増えにくくなるので、小さい小銭入れでも十分に対応できます。手持ちの小銭は意識して使うようにすれば、枚数はコントロールできます。

カードが入らない問題

小型財布に変えると、クレジットカードが2〜3枚しか入らないものもあります。

「カードが全部入らない」と不安に思いましたが、実際に必要なカードを数えてみると、ポイントカードを除いたら数枚で足りました。

クレジットカード1〜2枚、身分証、保険証。これだけ入ればほぼ困りません。

「念のため持ち歩く」カードは、実際にはほとんど使わないことが多いです。

まとめ：財布断捨離は「小さくする」だけでいい

「財布をやめる」というと大げさに聞こえますが、やることはシンプルです。

長財布を小型財布に変えて、決済をApple Payに寄せるだけ。

この構成にしてから5年、不便を感じたことはほぼありません。

財布が小さくなると、バッグの選択肢が増え、余計なものを持ち歩かなくなり、家計管理まで楽になります。

「財布を断捨離する」のハードルは、思っているより全然低いです。まずは今の財布の中身を一度全部出して、本当に必要なものだけを選んでみてください。

関連記事として、銀行口座を7個→2個に減らした話やクレジットカードを10枚→1枚に断捨離した話もあわせて読んでみてください。お金まわりの断捨離が一気に進みます。

そんな時に頼れるのが Streamlit（ストリームリット） です。

HTML/CSS はもちろん JavaScript も不要、Python だけで “見た目も機能も” 完結 するライトフレームワーク。

この記事では、完全初心者でも 最短 5 分で動くサンプルアプリ を作れるように解説します。

1. Streamlit とは？

Streamlit は、Python スクリプトをそのまま Web アプリに変換できる OSS（オープンソースソフトウェア）です。

データサイエンティストや機械学習エンジニアの「共有したい！」を起点に誕生し、現在（2025 年 6 月時点）も急速に進化中。

ぱっと作れる代表例

2. こんな人におすすめ

「自分に向いているか？」を 30 秒で判断できるよう、典型シーンを 3 つ紹介します。

Python の処理をブラウザ操作に置き換えたい

「PDF→画像変換」「CSV からレポート生成」など、ターミナル操作だと利用ハードルが高い スクリプトを
ボタン 1 つで動く Web ツール に変換できます。

データを可視化してチーム共有したい

pandas + plotly/matplotlib 連携で、インタラクティブなダッシュボード を数行で構築。

VPS や社内サーバーに置けば URL 共有だけ でメンバー全員が閲覧できます。

Web の知識ゼロでも外部公開したい

ルーティング／テンプレート／認証…といった設定は一旦忘れて OK。

既存の Python スクリプトに軽く追記するだけで、ポートフォリオや社内ツール を最速公開できます。

3. 5 分で作る ToDo アプリ

ここからは “手を動かす” パートです。

実際にコードを書きながら、Streamlit の流れを体験しましょう。

3-1. インストール

pip install streamlit

pip install streamlit

※ venv / conda など仮想環境をお使いの場合は、先にアクティベートしてください。

3-2. サンプルコード（app.py）

import streamlit as st

st.title("ToDoアプリ")

task = st.text_input("やることを入力してください")
if st.button("追加") and task:
    st.write(f"<img src="https://s.w.org/images/core/emoji/17.0.2/72x72/2705.png" alt="✅" class="wp-smiley" style="height: 1em; max-height: 1em;" /> {task}")

import streamlit as st

st.title("ToDoアプリ")

task = st.text_input("やることを入力してください")
if st.button("追加") and task:
    st.write(f"✅ {task}")

3-3. 起動

streamlit run app.py

streamlit run app.py

ブラウザが自動で開き、http://localhost:8501/ にアクセスすると ToDo アプリが表示されます。

4. よくある質問（Q&A）

導入時に最も質問が多いポイントを先回りでまとめました。

疑問があればまずここをチェック！

Q. HTML / CSS は本当に不要？

はい。すべて Python で完結 します。

裏側で自動生成されるため、フロントエンド知識がなくても問題ありません。

Q. 大規模アプリや複数ページは作れる？

• Streamlit は 単一ページ向け に最適化されており、URL 単位での画面遷移は非対応。
• 認証や REST API 提供が必要な場合は Flask / Django / FastAPI などを検討しましょう。

Q. 作ったアプリをネット公開できる？

できます。

VPS や PaaS（Render・Railway・Streamlit Community Cloud など）を使えば、外部公開が可能です。

次回記事で ConoHa VPS へのデプロイ手順 を解説予定！

5. まとめ

今回のポイントを 3 行で振り返りつつ、次のステップを案内します。

より詳しい構築方法や、Docker上にStreamlitアプリを構築する方法は、「【15分で作る】爆速でStreamlitでTODOアプリを実装する方法」で解説しました。

ぜひ、合わせて読み進めて見てください。

Pythonを使ってメールファイルを読み込みたい！

このような方に向けて、拡張子.emlファイルの読み込み方をご紹介します。

eml ファイルとは、電子メールのメッセージを保存するためのファイル形式です。

ファイルの中には以下のような情報が含まれています。

Python には email という標準ライブラリが用意されていて、これを使えば eml ファイルを読み込むことができます。

eml ファイルを読み込む方法

「eml ファイルを読み込む」ということを分解すると、次のようなステップに分けられます。

それぞれ順番に解説していきます。

1. eml ファイル全体を読み込む

まずは eml ファイルを、Python で扱えるオブジェクトとして読み込みます。

from email import policy
from email.parser import BytesParser

def read_email(eml_file_path):
    """
    emlファイルを読み込む
    """
    with open(eml_file_path, mode="rb") as f:
        msg = BytesParser(policy=policy.default).parse(f)
    return msg

from email import policy
from email.parser import BytesParser

def read_email(eml_file_path):
    """
    emlファイルを読み込む
    """
    with open(eml_file_path, mode="rb") as f:
        msg = BytesParser(policy=policy.default).parse(f)
    return msg

この read_email() 関数の引数として、拡張子が .eml のファイルパスを渡してあげればパースできます。

戻り値の msg は、Message オブジェクトです。

アノテーションをつけるなら、以下のような書き方になります。

from email import policy
from email.message import Message
from email.parser import BytesParser

def read_email(eml_file_path: str) -> Message:
    """
    emlファイルを読み込む
    """
    with open(eml_file_path, mode="rb") as f:
        msg = BytesParser(policy=policy.default).parse(f)
    return msg

from email import policy
from email.message import Message
from email.parser import BytesParser

def read_email(eml_file_path: str) -> Message:
    """
    emlファイルを読み込む
    """
    with open(eml_file_path, mode="rb") as f:
        msg = BytesParser(policy=policy.default).parse(f)
    return msg

パースとは「ただのテキストファイル」を解析して、Python で認識可能なオブジェクトに変換することです。

2. 送信者情報、件名などの要素を取得する

1. で取得した Message オブジェクトから、以下の情報を取得していきます。

Message オブジェクトは辞書のような方法でアクセスできます。

取得例は以下の通り。

# 送信者メールアドレス
from_ = msg.get("From", None)

# 受信者メールアドレス
to = msg.get("To", None)

# 件名
subject = msg.get("Subject", None)

# CC
cc = msg,get("CC", None)

# 送信日時
date = msg.get("Date", None)

# メールごとに振られたユニークな識別子
message_id = msg.get("Message-ID", None)

# 送信者メールアドレス
from_ = msg.get("From", None)

# 受信者メールアドレス
to = msg.get("To", None)

# 件名
subject = msg.get("Subject", None)

# CC
cc = msg,get("CC", None)

# 送信日時
date = msg.get("Date", None)

# メールごとに振られたユニークな識別子
message_id = msg.get("Message-ID", None)

もちろん通常の辞書と同様msg["From"]のような形でも取り出せますが、上記では取得できなかったときのためにget()メソッドにNoneを明示しておくことで、安全にアクセスできるようにしました。

なお、メールアドレスはname<sample@name.com>の形式になることがあります。
これを「名前部分」と「純粋なメールアドレス部分」を分けて取得したい場合にはparseaddr()メソッドを使って分離しましょう。

def divide_name_and_mailaddress(mailaddress):
    """
    フルメールアドレス, 純粋なメールアドレス部分を分ける
    """
    try:
        return [parseaddr(mailaddress)[0], parseaddr(mailaddress)[1]]
    except Exception:
        return None

def divide_name_and_mailaddress(mailaddress):
    """
    フルメールアドレス, 純粋なメールアドレス部分を分ける
    """
    try:
        return [parseaddr(mailaddress)[0], parseaddr(mailaddress)[1]]
    except Exception:
        return None

BCC は受信者側から見えないので、msg["BCC"]とすることはまずありません。

3. 本文を取得する

本文の取得には、一工夫が必要です。

大前提として、メールファイルには次の2種類があります。

それぞれ簡単に説明します。

まずシングルパートは、ただのテキストだけからなるシンプルな構成のものです。

一方のマルチパートは、テキストとHTMLが混在していたり、テキストの他に添付ファイルを含む場合にあたります。

つまり色々なコンテンツがある場合にはマルチパート、単一のコンテンツのメールならシングルパートということになります。

メール本文を読み込むには、マルチパートかシングルパートかを場合分けして処理する必要があるので、以下のように条件分岐を組んで取り出します。

def get_email_body(msg: Message) -> str:
    """
    メール本文を取得する
    """
    if msg.is_multipart():
        # マルチパートメールの場合
        # つまり、添付ありやHTML形式のメールの場合
        for part in msg.walk():
            # コンテントタイプを取得
            content_type = part.get_content_type()
            # Content-Dispositionヘッダの内容を取得する
            content_disposition = str(part.get("Content-Disposition"))

            if content_type == "text/plain" and "attachment" not in content_disposition:
                payload = part.get_payload(decode=True)
                detected = chardet.detect(payload)
                encoding = (
                    detected["encoding"]
                    if detected["encoding"] is not None
                    else "utf-8"
                )
                # エラーの場合は文字化けしてでも文字列を出力
                return payload.decode(encoding, errors="replace")
    else:
        # メールの内容を取得
        payload = msg.get_payload(decode=True)
        # エンコード方式を確認
        detected = chardet.detect(payload)
        # 得られたエンコード方式がnoneならutf-8を、そうでなければ得られたものを採用
        encoding = detected["encoding"] if detected["encoding"] is not None else "utf-8"
        # エラーの場合は文字化けしてでも文字列を出力
        return payload.decode(encoding, errors="replace")

def get_email_body(msg: Message) -> str:
    """
    メール本文を取得する
    """
    if msg.is_multipart():
        # マルチパートメールの場合
        # つまり、添付ありやHTML形式のメールの場合
        for part in msg.walk():
            # コンテントタイプを取得
            content_type = part.get_content_type()
            # Content-Dispositionヘッダの内容を取得する
            content_disposition = str(part.get("Content-Disposition"))

            if content_type == "text/plain" and "attachment" not in content_disposition:
                payload = part.get_payload(decode=True)
                detected = chardet.detect(payload)
                encoding = (
                    detected["encoding"]
                    if detected["encoding"] is not None
                    else "utf-8"
                )
                # エラーの場合は文字化けしてでも文字列を出力
                return payload.decode(encoding, errors="replace")
    else:
        # メールの内容を取得
        payload = msg.get_payload(decode=True)
        # エンコード方式を確認
        detected = chardet.detect(payload)
        # 得られたエンコード方式がnoneならutf-8を、そうでなければ得られたものを採用
        encoding = detected["encoding"] if detected["encoding"] is not None else "utf-8"
        # エラーの場合は文字化けしてでも文字列を出力
        return payload.decode(encoding, errors="replace")

まとめ

emlファイルから情報取得する流れは以下の通りです。

この流れをおさえた上で本記事の内容を参考にしていただければ、メールデータを簡単に取り出せるはずです。

ご不明な点などありましたら、コメント欄にメッセージいただければご回答させていただきます。

Visual Studio Code（以下「VSCode」）のインストール方法を知りたい人向けの記事です。

本記事ではVSCodeをインストールする２つの方法をご紹介します。

基本的には一つ目の「公式サイトからダウンロードする方法」が推奨です。

一方で、普段からターミナルよく使う方は「Homebrew を使った方法」をおすすめします。（慣れてる方からしたら、こちらの方が簡単なため）

以下が目次になっているので、お好きな方をクリックして進んでください。

CFXLOG

最後におすすめの拡張機能も紹介します。

方法1: 公式サイトからダウンロードする方法

アプリを公式サイトからダウンロードしてきて、インストールする方法です。

ターミナル操作に不安がある方は、この方法をお試しください。

VSCodeのダウンロード

以下の公式ページにアクセスします。

» 参考：Visual Studio Code – Code Editing. Redefined

時期によって多少は画面が違うかもしれませんが、下のような画面が表示されるはずです。

「Download for macOS」という青いボタンをクリックしましょう。

しばらくするとDownloadフォルダにzipファイルが表示されるので、ダブルクリックして解凍します。

アイコン付きのものが、VSCode本体です。

これをアプリケーションフォルダにドラッグ&ドロップで移動させましょう。

これでインストールは完了です。

VSCodeの起動方法

「コマンド（⌘） + スペース」を同時押しして、Spotlight を起動しましょう。

そこにvisualと入力すると、Visual Studio Codeが表示されます。

これを選んでEnterキーを押せば、VSCodeが立ち上がります。

方法2: Homebrew を使った方法

コマンド実行でVSCodeをインストールすることも可能です。

ダウンロードする方法に比べて楽に導入できるので、ターミナル操作に抵抗がない方はこちらがおすすめ。

Homebrewをインストールする

最初にHomebrewがインストールされているか確認するため、次のコマンドを実行してください。

~ % brew -v
zsh: command not found: brew

~ % brew -v
zsh: command not found: brew

command not found: brewと表示された場合は、Homebrewがまだ入っていません。

※ バージョンが返ってきた方はインストールの必要がないため、こちらにお進みください。

以下のコマンドでHomebrewをインストールしましょう。

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

しばらくすると、次のようなメッセージが表示されるはずです。

==> Next steps:
- Run these commands in your terminal to add Homebrew to your PATH:
    echo >> /Users/****/.zprofile
    echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> /Users/****/.zprofile
    eval "$(/opt/homebrew/bin/brew shellenv)"
- Run brew help to get started
- Further documentation:
    https://docs.brew.sh/

==> Next steps:
- Run these commands in your terminal to add Homebrew to your PATH:
    echo >> /Users/****/.zprofile
    echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> /Users/****/.zprofile
    eval "$(/opt/homebrew/bin/brew shellenv)"
- Run brew help to get started
- Further documentation:
    https://docs.brew.sh/

つまり、Homebrewを正しく動作させるためにコマンドの実行を求めています。

指示にある通り、ターミナルで次のコマンドを実行します。

echo >> /Users/****/.zprofile
echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> /Users/****/.zprofile
eval "$(/opt/homebrew/bin/brew shellenv)"

echo >> /Users/****/.zprofile
echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> /Users/****/.zprofile
eval "$(/opt/homebrew/bin/brew shellenv)"

※ 上記はユーザー名を差し替えているので、必ずターミナル上に表示されたコマンドをコピペして実行してください。

最後に次のコマンドを実行して、バージョンが戻ってくれば成功です。

~ % brew -v      
# Homebrew 4.4.0

~ % brew -v      
# Homebrew 4.4.0

VSCodeのインストール

あとは次のコマンドを実行するだけです。

brew install --cask visual-studio-code

brew install --cask visual-studio-code

コマンド実行後、successfully installed! と表示されるまで待ちましょう。

公式サイトからのダウンロードに比べて、格段にラクです。

VSCodeの起動方法

起動方法は、ターミナルで以下のコマンドを実行するだけです。

code

code

特定のフォルダを開きたい場合は、引数として開きたい階層のパスを指定します。

code .

code .

上記の場合は引数を.にしたので、カレントディレクトリを開きます。

CFXLOG

もちろん上で紹介したような通常の起動方法でも可能です！

最初に入れるべき拡張機能２選

最近のVSCodeはデフォルト機能がかなり充実しているので、必要な拡張機能はそう多くありません。

ここではVSCodeインストールと同時に導入したい拡張機能をご紹介します。

インストールには、各拡張機能の最後に設置したリンクをクリックしてください。
ページ内の緑色のInstallボタンを押すとVSCodeで拡張機能が開くので、そこでInstallボタンを押します。

Japanese Language Pack for Visual Studio Code

VSCodeはデフォルトで英語です。

日本語化したい場合には、この拡張機能を入れましょう。

microsoftが公式に提供しているので安心して使えます。

» インストールはこちら：Japanese Language Pack for Visual Studio Code

Rainbow CSV

CSVを列ごとに色分けしてくれます。

VSCodeではCSVを表示するときに、Excelのように表形式になりません。

生のCSVを編集するときなど、どの列を編集しているか分かりやすくなるので便利です。

» インストールはこちら：Rainbow CSV

まとめ

VSCodeのインストール方法をご紹介しました。

どちらを選んでも結果は同じなので、お好みの方を選んでください。

このような方に向けて書きました。

頑張って開発したアプリケーションを他の人に使っていただくときに、通常のアプリケーションのようにダブルクリックで起動する「実行ファイル」にしておくと親切です。

Pyhthon の実行ファイル化ツールで最も利用されているのは PyInstaller です。

初見ではオプションの指定方法や.specファイルの書き方など、なかなか理解できない箇所も多くあります。

本記事では「これから PyInstaller で実行ファイル化したい！」という方に向けて、必要な知識や実行ファイル化の手順をわかりやすく解説します。

PyInstaller の概要を解説

まずは、PyInstaller を使うために必要な前提知識からご紹介します。

PyInstallerの概要

PyInstaller は Python プログラムを「実行ファイル」に変換するツールです。

Windows, Mac, Linux に対応しています。

詳しくは後述しますが、.specファイルでビルドする際の挙動を調整できたり、細かい設定が効くので、配布用に変換するには絶好のツールです。

ただし、出力される実行ファイルの容量は大きくなりがちなのがデメリットではあります。

他のパッケージングツールと比較

他のパッケージングツールとの比較を表にまとめました。

海外ではnuitkaが使われることも多いようですが、設定が複雑なのでちょっと使いづらかったです。

やっぱりPyInstallerが総合してバランスが取れていると思います。

実行ファイルの構成

PyInstaller 実行後には、以下が出力されます。

具体的には以下のような構成です。

my_project/
├── my_script.py
├── my_script.spec
├── build/
│   └── my_script/
│       ├── base_library.zip
│       ├── my_script.exe.manifest
│       ├── my_script.exe.pyi
│       ├── warn-my_script.txt
│       └── <その他の中間ファイル>
└── dist/
    └── my_script/
        ├── my_script.exe
        ├── <依存ファイル1>
        ├── <依存ファイル2>
        └── <その他の依存ファイル>

my_project/
├── my_script.py
├── my_script.spec
├── build/
│   └── my_script/
│       ├── base_library.zip
│       ├── my_script.exe.manifest
│       ├── my_script.exe.pyi
│       ├── warn-my_script.txt
│       └── <その他の中間ファイル>
└── dist/
    └── my_script/
        ├── my_script.exe
        ├── <依存ファイル1>
        ├── <依存ファイル2>
        └── <その他の依存ファイル>

.specファイルについては、本記事の後半で詳しく解説します。

PyInstaller で実行ファイル化するまでの流れ

PyInstaller は Python プログラムをスタンドアロンの実行可能なファイル（.exe、.appなど）に変換するツールです。実行ファイル化には、以下の手順で行います。

順番に解説します。

インストール

まずはお使いの環境に Python がインストールされているか確認します。

python --version

# 結果
# Python 3.11.7

python --version

# 結果
# Python 3.11.7

バージョンが帰ってくれば、Python がインストールされているということなので次に進みましょう。

続いて、PyInstaller のインストールをします。

pip install pyinstaller

pip install pyinstaller

念の為以下のコマンドで、正常にPyInstaller がインストールされたか確認しましょう。

pyinstaller --version

# 結果
# 6.6.0

pyinstaller --version

# 結果
# 6.6.0

バージョンが返ってくればインストールは成功です！

Python スクリプトを用意する

ごく簡単なスクリプトとしてmyscript.pyを作ります。

print("hello, world")

print("hello, world")

次の手順で、このスクリプトを実行ファイル化していきます。

PyInstaller の実行

コマンドラインから、以下のコマンドを実行します。

pyinstaller myscript.py

pyinstaller myscript.py

distフォルダとbuildフォルダが作成されて、distフォルダ内に実行ファイルが生成されます。

ちなみにコマンドにはオプションを設定することができます。

上記のオプションを使った場合のコマンド例はこちら。

pyinstaller --onefile --noconsole --icon=my_icon.ico --clean myscript.py

pyinstaller --onefile --noconsole --icon=my_icon.ico --clean myscript.py

その他のオプションについては、公式ドキュメントをご参照ください。

» 参考：Using Pyinstaller – Options

実行方法

distフォルダ内に生成された実行可能ファイルを実行します。

./dist/myscript

./dist/myscript

これで先ほどのmyscriptが実行され、Hello, World!の文字列が表示されるようになります。

Hello, World!

Saving session...
...copying shared history...
...saving history...truncating history files...
...completed.

[プロセスが完了しました]

Hello, World!

Saving session...
...copying shared history...
...saving history...truncating history files...
...completed.

[プロセスが完了しました]

今回の場合にはコンソール上にprint()するだけなので、実行ファイル化する際には--noconsoleを入れないようにしましょう。

入れてしまうとprint()関数の結果が見られないためです。

spec ファイルを使ったビルド

PyInstaller では--noconsoleなどのオプションをつけてビルドを行うものが主流ですが、.specファイルでビルド内容を定義することができます。

メリットは次のとおり。

何度もオプションを書いてビルドし直す、という面倒な作業がなくなります。

以下、詳細を見ていきましょう。

spec ファイルの生成方法

.specファイルは、通常のビルドコマンドを実行すると生成されます。

pyinstaller myscript.py

pyinstaller myscript.py

myscript.specというファイルが出力されるので、内容を確認していきましょう。

# -*- mode: python ; coding: utf-8 -*-

block_cipher = None

a = Analysis(
    ['myscript.py'],
    pathex=['/path/to/your/script'],
    binaries=[],
    datas=[],
    hiddenimports=[],
    hookspath=[],
    runtime_hooks=[],
    excludes=[],
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
)
pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='myscript',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    upx_exclude=[],
    runtime_tmpdir=None,
    console=True,
)
coll = COLLECT(
    exe,
    a.binaries,
    a.zipfiles,
    a.datas,
    strip=False,
    upx=True,
    upx_exclude=[],
    name='myscript',
)

# -*- mode: python ; coding: utf-8 -*-

block_cipher = None

a = Analysis(
    ['myscript.py'],
    pathex=['/path/to/your/script'],
    binaries=[],
    datas=[],
    hiddenimports=[],
    hookspath=[],
    runtime_hooks=[],
    excludes=[],
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
)
pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='myscript',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    upx_exclude=[],
    runtime_tmpdir=None,
    console=True,
)
coll = COLLECT(
    exe,
    a.binaries,
    a.zipfiles,
    a.datas,
    strip=False,
    upx=True,
    upx_exclude=[],
    name='myscript',
)

specファイルを使ったビルド

.specファイルを使ってビルドする場合には、以下のコマンドを実行します。

pyinstaller myscript.spec

pyinstaller myscript.spec

これで.specファイルの内容をもとに実行ファイルが出力されます。

.spec ファイルのカスタマイズ

.specファイルをカスタマイズして、ビルドの内容を変更する方法をご紹介します。

単一ファイル出力

onefileオプションのように、単一ファイル出力する方法です。

以下のように、.specファイルを編集します。

exe = EXE(
    ・・・
    exclude_binaries=True,  # onefileオプション
    ・・・
)

# onefileのためにCOLLECTステップを削除

exe = EXE(
    ・・・
    exclude_binaries=True,  # onefileオプション
    ・・・
)

# onefileのためにCOLLECTステップを削除

仮にexclude_binaries=Falseとした場合、アプリの受付部分にあたる「実行ファイル」と実際のロジックを担当する「バイナリ」に分割されます。

分割することで「各ファイルを独立して管理」できたり「ビルド時間やファイルサイズが小さくなる」というメリットもあります。

ただし、配布時にはわかりやすさ重視でonefileオプションをつけることのほうが多いです。

コンソールの非表示

--noconsoleオプションと同じ設定を行います。

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='myscript',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    upx_exclude=[],
    runtime_tmpdir=None,
    console=False,  # noconsole オプション
)

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='myscript',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    upx_exclude=[],
    runtime_tmpdir=None,
    console=False,  # noconsole オプション
)

これでコンソールが非表示になります。GUIアプリなどはこの設定が良いです。

逆に、あえてコンソールを表示させたい場合にはconsole=Trueを指定しましょう。

アイコンの設定

EXEセクションでiconパラメータを追加します。

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='myscript',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    upx_exclude=[],
    runtime_tmpdir=None,
    console=True,
    icon='path/to/icon.ico'
)

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='myscript',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    upx_exclude=[],
    runtime_tmpdir=None,
    console=True,
    icon='path/to/icon.ico'
)

デバッグとトラブルシューティングの方法

PyInstaller でよくあるエラーと対処法をご紹介します。

また、実行ファイル化後のトラブルについても具体的な対策に触れていきましょう。

ModuleNotFoundError

モジュールがビルド対象から外れてしまった場合に表示されるエラーです。

ModuleNotFoundError: No module named 'some_module'

ModuleNotFoundError: No module named 'some_module'

この場合、.specファイルのhiddenimportsにモジュールを追加します。

# .specファイルの編集
a = Analysis(['my_script.py'],
             pathex=['/path/to/my_project'],
             hiddenimports=['some_module'],  # 見つからなかったモジュールを指定
             ...)

# .specファイルの編集
a = Analysis(['my_script.py'],
             pathex=['/path/to/my_project'],
             hiddenimports=['some_module'],  # 見つからなかったモジュールを指定
             ...)

ImportError

外部ライブラリのインポートに失敗した場合のエラーです。

ImportError: DLL load failed: The specified module could not be found.

ImportError: DLL load failed: The specified module could not be found.

.specファイルのbinariesにライブラリのパスを追加します。

# .specファイルの編集
binaries=[('path/to/dll_or_shared_library', '.')]

# .specファイルの編集
binaries=[('path/to/dll_or_shared_library', '.')]

FileNotFoundError

指定されたファイルパスが間違っている場合のエラーです。

FileNotFoundError: [Errno 2] No such file or directory: 'some_file'

FileNotFoundError: [Errno 2] No such file or directory: 'some_file'

datasにデータファイルの絶対パスを追加します。

# .specファイルの編集
datas=[('path/to/datafile', 'destination_directory')]

# .specファイルの編集
datas=[('path/to/datafile', 'destination_directory')]

デバッグモードの使用

PyInstaller のデバッグモードを使うことで、詳細なログを見ることができます。

pyinstaller --onefile --debug=all my_script.py

pyinstaller --onefile --debug=all my_script.py

デバッグモードには二種類あります。

これにより、コンソール上に詳細なログが表示されるようになります。

どこで問題が起きたかがわかるので、とても便利です。

Python スクリプト内でログ出力する

アプリケーション実行中のエラーは、スクリプト内にログ出力するようにすることでも対応できます。

import logging

logging.basicConfig(level=logging.DEBUG)
logging.debug("This is a debug message")

import logging

logging.basicConfig(level=logging.DEBUG)
logging.debug("This is a debug message")

※ ログ出力の方法については、後日別記事でご紹介する予定です。

【アドバンス】PyInstaller が行う処理の流れ

specファイルを読み前提知識として、PyInstaller の処理の流れを理解しておきましょう。

以下の順番で処理が流れていき、実行ファイルが生成されます。

順番に解説していきます。

ファイルを分析

実行ファイル化したい Python スクリプトを含む、すべてのファイルを調べるフェーズです。

.specファイルでは、Analysisオブジェクトとして表現されてます。

a = Analysis(
    ['myscript.py'],  # 対象の Python スクリプト名
    pathex=['/path/to/your/script'],  # スクリプトのパスを指定
    binaries=[],  # 追加のバイナリファイル(DLL, SOファイル)
    datas=[],  # 追加のデータファイル(画像、設定ファイルなど)
    hiddenimports=[],  # PyInstaller が自動検出できないモジュールのリスト
    hookspath=[],  # カスタムフックファイル
    runtime_hooks=[],  # アプリ実行時に実行されるスクリプトのリスト
    excludes=[],  # PyInstaller に含めないモジュールリスト
)

a = Analysis(
    ['myscript.py'],  # 対象の Python スクリプト名
    pathex=['/path/to/your/script'],  # スクリプトのパスを指定
    binaries=[],  # 追加のバイナリファイル(DLL, SOファイル)
    datas=[],  # 追加のデータファイル(画像、設定ファイルなど)
    hiddenimports=[],  # PyInstaller が自動検出できないモジュールのリスト
    hookspath=[],  # カスタムフックファイル
    runtime_hooks=[],  # アプリ実行時に実行されるスクリプトのリスト
    excludes=[],  # PyInstaller に含めないモジュールリスト
)

この場合には、/path/to/your/scriptからmyscript.pyを探して、これを実行ファイル化します。

複数のスクリプトで構築した場合には、最初に指定したスクリプトが最初に実行されるエントリーポイントになります。

PYZ オブジェクトを作成

続いては、Analysis で対象とされた Python ファイルをアーカイブにまとめます。

pyz = PYZ(a.pure, a.zipped_data)

pyz = PYZ(a.pure, a.zipped_data)

a.pureはAnalysisで取得された純粋な Python スクリプトのリストです。

a.zipped_dataはそれ以外のファイル群で、Python モジュールが依存している圧縮ファイルなどが指定されます。

いずれにせよPYZオブジェクトは PyInstaller のビルド時に自動的に出力されるものなので、手動でいじることはほとんどないです。

EXE オブジェクトを作成

実際の実行ファイルを作成するステップです。

exe = EXE(
    pyz,  # 一つ前のステップで作成した PYZ オブジェクト
    a.scripts,  # Analysis オブジェクトで解析されたスクリプト
    [],  # 追加の Python スクリプトを指定する場合に必要
    exclude_binaries=False,  # バイナリと実行ファイルを分離しない
    name='myscript',  # 実行ファイルの名前
)

exe = EXE(
    pyz,  # 一つ前のステップで作成した PYZ オブジェクト
    a.scripts,  # Analysis オブジェクトで解析されたスクリプト
    [],  # 追加の Python スクリプトを指定する場合に必要
    exclude_binaries=False,  # バイナリと実行ファイルを分離しない
    name='myscript',  # 実行ファイルの名前
)

すべてのファイルを統合

COLLECTでは、AnalysisとEXEをまとめて「最終的なディレクトリ構造」を作成します。

coll = COLLECT(
    exe,  # 先に作成したEXEオブジェクト
    a.binaries,  # 解析されたバイナリのリスト
    a.zipfiles,  # 解析された圧縮ファイルのリスト
    a.datas,  # 解析されたエータファイルのリスト
    strip=False,  # デバッグ情報等を含めない
    upx=True,  # True にすると UPX で圧縮
    name='myscript',  # 出力ディレクトリ名を指定
)

coll = COLLECT(
    exe,  # 先に作成したEXEオブジェクト
    a.binaries,  # 解析されたバイナリのリスト
    a.zipfiles,  # 解析された圧縮ファイルのリスト
    a.datas,  # 解析されたエータファイルのリスト
    strip=False,  # デバッグ情報等を含めない
    upx=True,  # True にすると UPX で圧縮
    name='myscript',  # 出力ディレクトリ名を指定
)

onefileオプションをつけた場合には、COLLECTステップがありません。

そのため、EXEには以下のようになっているはずです。

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,  # これがonefileに相当
    name='myscript',
)

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,  # これがonefileに相当
    name='myscript',
)

補足：こんなときにどうする？

PyInstallerを使っていると、たまに問題に出くわすことがあります。

このセクションでは、Q＆A形式でお答えしていきます。

まとめ

PuInstaller は、以下の内容を理解しておくと全体像が把握しやすいです。

ぜひ、参考にしてみてください。

requests ライブラリの役割は、HTTP リクエストを行うことです。

つまり Python を使って Web 上から自由に情報取得できるようになるので、プログラムに実装できる機能の幅が一気に広がります。

本記事では、難易度の低い「Web API へのアクセス方法」を解説します。

後日 Beautiful Soup を併用した「スクレイピングの方法」を別記事にしようと思っていますので、記事が完成しましたらこちらでご案内する予定です。

なお、requests ライブラリをさらに深く理解するためには HTTP 通信の理解が必須です。HTTP の理解に不安がある方には、『Real World HTTP』の通読を強くおすすめします。

requests ライブラリのざっくりした説明

requests ライブラリの役割

Python を使って HTTP 通信するためのライブラリです。

つまり自分の手元にある PC と遠隔地にあるサーバーとの間で、HTTP というルールに従って情報を送信したり受信したりできるものになります。

ライブラリ名は、サーバーに情報を要求する = “requests” と考えるとわかりやすいかもしれません。

直感的な理解のために、具体例をあげてみます。

普段 Chrome などのブラウザのアドレスバーに「http://~」などと打ち込むことがあると思いますが、その時には裏側で以下のことが行われています。/

この「ページの内容を要求（リクエスト）する」ことと、「ページの内容が返却（レスポンス）される」部分にHTTP通信が利用されているというわけです。

urllib ライブラリとの違い

Python には urllib という標準モジュールがあります。
実は、この urllib.request を使っても HTTP 通信を行うことは可能です。

ただし、特別な理由がない限り requests ライブラリを推奨します。

requests ライブラリは urllib をより使いやすくカスタマイズしたものであり、同じことをするにしても urllib.request を使うと相当コード量が増えてしまうからです。

requests を使った Web API へのアクセス方法

Web APIへのアクセスは、以下の流れで行います。

今回は、例として「天気予報 API（livedoor 天気互換）」を活用してみます。

気象庁から配信されている日本全国の天気予報を取得できます。

利用する Web API の調査

最初の段階で、以下の内容は調査しておくと良いです。

API の利用規約を精読する

利用規約には API を使うためのお約束ごとです。必ず確認するようにしてください。

まず、有料・無料を確認します。

サービスの利用は無料ですが、この API を利用したことで何らかの不具合が発生しても責任は負えません。自己責任にてお願いします。

天気予報 API（livedoor 天気互換）

そして必ず確認したいのが、リクエストのレート制限についてです。

過度に Web API に対してリクエストを送ってしまうとサーバーに大きな負担をかけてしまい、最悪の場合はサーバーがダウンしてしまいます。

そのようなことがないよう、通常は API の利用規約内に「リクエストは〇〇秒以上の間隔をあけてアクセスするように」などの決まりが書かれています。

今回の天気予報 API では、以下の記述がありました。

あまり強いサーバーではないので、API に連続してアクセスする場合は最低でも 0.5 秒以上間隔を空けてから行ってください。

天気予報 API（livedoor 天気互換）

仮に書かれていなかった場合には、API 提供者に確認をとってみるのも良いでしょう。

また商用利用する場合には、商用 OK かどうかもチェックしてください。

かなり大事なステップです。
利用規約の読み込みは丁寧に行ない、不明点を潰した状態で次のステップに進んでください。

アクセス先のURL（エンドポイント）を調べる

続いて、アクセス先の URL を確認します。

JSON データをリクエストする際のベースとなる URL は以下になります。
https://weather.tsukumijima.net/api/forecast
この URL に下の表のパラメータを加え、実際にリクエストします。

天気予報 API（livedoor 天気互換）

上記をベースに、city パラメータを加えてリクエストする仕様のようです。

地域別に定義された ID 番号を表します。
リクエストする地域と ID の対応は、livedoor 天気で使われていた 全国の地点定義表 内で「一次細分区域（cityタグ）」の ID をご参照ください。（例・佐賀県 伊万里 = 410020 ）

天気予報 API（livedoor 天気互換）

久留米市の天気を取得する場合は以下とするようです。

下記 URL にアクセスして JSON データを取得します。
基本 URL + 久留米の ID (400040)
https://weather.tsukumijima.net/api/forecast/city/400040

クエリで取得することもできます。
https://weather.tsukumijima.net/api/forecast?city=400040

天気予報 API（livedoor 天気互換）

今回はエンドポイントが一つでしたが、APIによっては複数のエンドポイントが用意されていることの方が多いです。

欲しい情報にアクセスできるエンドポイントを見つけ出してください。

認証系で必要な情報を確認する

API によっては、以下のような追加の認証情報が必要になることがあります。

これらは利用者を識別するためのものです。

必要な場合に requests ライブラリでリクエストを送る際に、これらの認証情報を添付することになります。

ちなみに今回利用する「天気予報 API」では認証情報は要求されないようでした。

ライブラリのインストール

ライブラリ名はrequestsです。

以下のコマンドを実行してインストールを行いましょう。

pip install requests

pip install requests

コードを作成・実行する

最後にコードを作成します。

今回の「天気予報API」ではクエリパラメータとして場所に関する情報を渡す必要があるので、以下のように params をリクエストに含めました。

import requests

endpoint = "https://weather.tsukumijima.net/api/forecast"

params = {
    "city": 400040,
}

response = requests.get(endpoint, params=params)

# 結果を表示
print(response.text)

import requests

endpoint = "https://weather.tsukumijima.net/api/forecast"

params = {
    "city": 400040,
}

response = requests.get(endpoint, params=params)

# 結果を表示
print(response.text)

すると print(response.txt) の部分が実行され、以下が表示されるはずです。

{
  "publicTime": "2024-01-27T11:00:00+09:00",
  "publicTimeFormatted": "2024/01/27 11:00:00",
  "publishingOffice": "福岡管区気象台",
  "title": "福岡県 久留米 の天気",
  "link": "https://www.jma.go.jp/bosai/forecast/#area_type=offices&area_code=400000",
  "description": {
    "publicTime": "2024-01-27T10:39:00+09:00",
    "publicTimeFormatted": "2024/01/27 10:39:00",
    "headlineText": "",
    "bodyText": "　福岡県は、高気圧に覆われて晴れの所もありますが、気圧の谷や寒気の影響により、おおむね曇りとなっています。\n\n　２７日は、高気圧に覆われて晴れる所もありますが、気圧の谷や寒気の影響により、おおむね曇りとなるでしょう。\n\n　２８日は、気圧の谷や寒気の影響により曇りで、雨や雪となり雷を伴う所がありますが、高気圧に覆われて次第に晴れとなるでしょう。\n\n＜天気変化等の留意点＞\n　２７日１２時から２８日１２時までに予想される１時間降水量は、多い所で、筑後地方で５ミリ、２７日１２時から２８日１２時までに予想される２４時間降水量は、多い所で、筑後地方で１０ミリの見込みです。",
    "text": "　福岡県は、高気圧に覆われて晴れの所もありますが、気圧の谷や寒気の影響により、おおむね曇りとなっています。\n\n　２７日は、高気圧に覆われて晴れる所もありますが、気圧の谷や寒気の影響により、おおむね曇りとなるでしょう。\n\n　２８日は、気圧の谷や寒気の影響により曇りで、雨や雪となり雷を伴う所がありますが、高気圧に覆われて次第に晴れとなるでしょう。\n\n＜天気変化等の留意点＞\n　２７日１２時から２８日１２時までに予想される１時間降水量は、多い所で、筑後地方で５ミリ、２７日１２時から２８日１２時までに予想される２４時間降水量は、多い所で、筑後地方で１０ミリの見込みです。"
  },
  "forecasts": [
    {
      "date": "2024-01-27",
      "dateLabel": "今日",
      "telop": "晴時々曇",
    ・・・
// 以下、省略

{
  "publicTime": "2024-01-27T11:00:00+09:00",
  "publicTimeFormatted": "2024/01/27 11:00:00",
  "publishingOffice": "福岡管区気象台",
  "title": "福岡県 久留米 の天気",
  "link": "https://www.jma.go.jp/bosai/forecast/#area_type=offices&area_code=400000",
  "description": {
    "publicTime": "2024-01-27T10:39:00+09:00",
    "publicTimeFormatted": "2024/01/27 10:39:00",
    "headlineText": "",
    "bodyText": "　福岡県は、高気圧に覆われて晴れの所もありますが、気圧の谷や寒気の影響により、おおむね曇りとなっています。\n\n　２７日は、高気圧に覆われて晴れる所もありますが、気圧の谷や寒気の影響により、おおむね曇りとなるでしょう。\n\n　２８日は、気圧の谷や寒気の影響により曇りで、雨や雪となり雷を伴う所がありますが、高気圧に覆われて次第に晴れとなるでしょう。\n\n＜天気変化等の留意点＞\n　２７日１２時から２８日１２時までに予想される１時間降水量は、多い所で、筑後地方で５ミリ、２７日１２時から２８日１２時までに予想される２４時間降水量は、多い所で、筑後地方で１０ミリの見込みです。",
    "text": "　福岡県は、高気圧に覆われて晴れの所もありますが、気圧の谷や寒気の影響により、おおむね曇りとなっています。\n\n　２７日は、高気圧に覆われて晴れる所もありますが、気圧の谷や寒気の影響により、おおむね曇りとなるでしょう。\n\n　２８日は、気圧の谷や寒気の影響により曇りで、雨や雪となり雷を伴う所がありますが、高気圧に覆われて次第に晴れとなるでしょう。\n\n＜天気変化等の留意点＞\n　２７日１２時から２８日１２時までに予想される１時間降水量は、多い所で、筑後地方で５ミリ、２７日１２時から２８日１２時までに予想される２４時間降水量は、多い所で、筑後地方で１０ミリの見込みです。"
  },
  "forecasts": [
    {
      "date": "2024-01-27",
      "dateLabel": "今日",
      "telop": "晴時々曇",
    ・・・
// 以下、省略

実装のために知っておくと便利な知識

レスポンスのうち、要素の一部を取得する

上記で response として受け取ったデータは、Response オブジェクトです。

これではちょっと扱いづらいので、以下の流れで辞書にしてから要素を取り出すことが多いと思います。

先ほどのレスポンスを例に、title の値を取得するコード例を示します。

import requests

endpoint = "https://weather.tsukumijima.net/api/forecast"

params = {
    "city": 400040,
}

response = requests.get(endpoint, params=params)

# json() メソッドで辞書に変換する
response_dict = response.json()
title = response_dict["title"]

print(title) 

import requests

endpoint = "https://weather.tsukumijima.net/api/forecast"

params = {
    "city": 400040,
}

response = requests.get(endpoint, params=params)

# json() メソッドで辞書に変換する
response_dict = response.json()
title = response_dict["title"]

print(title) 

すると、title に対応する値のみが出力されました。

福岡県 久留米 の天気

福岡県 久留米 の天気

例えば bodyText などのより深い階層にある要素も、一般的な辞書の操作方法で取り出せます。

import requests

endpoint = "https://weather.tsukumijima.net/api/forecast"

params = {
    "city": 400040,
}

response = requests.get(endpoint, params=params)

# json() メソッドで辞書に変換する
response_dict = response.json()
# bodyText を取得する
body_text = response_dict["description"]["bodyText"]

print(body_text) 

import requests

endpoint = "https://weather.tsukumijima.net/api/forecast"

params = {
    "city": 400040,
}

response = requests.get(endpoint, params=params)

# json() メソッドで辞書に変換する
response_dict = response.json()
# bodyText を取得する
body_text = response_dict["description"]["bodyText"]

print(body_text) 

実行結果は以下になります。

　福岡県は、高気圧に覆われて晴れの所もありますが、気圧の谷や寒気の影響により、おおむね曇りとなっています。

　２７日は、高気圧に覆われて晴れる所もありますが、気圧の谷や寒気の影響により、おおむね曇りとなるでしょう。

　２８日は、気圧の谷や寒気の影響により曇りで、雨や雪となり雷を伴う所がありますが、高気圧に覆われて次第に晴れとなるでしょう。

＜天気変化等の留意点＞
　２７日１２時から２８日１２時までに予想される１時間降水量は、多い所で、筑後地方で５ミリ、２７日１２時から２８日１２時までに予想される２４時間降水量は、多い所で、筑後地方で１０ミリの見込みです。

　福岡県は、高気圧に覆われて晴れの所もありますが、気圧の谷や寒気の影響により、おおむね曇りとなっています。

　２７日は、高気圧に覆われて晴れる所もありますが、気圧の谷や寒気の影響により、おおむね曇りとなるでしょう。

　２８日は、気圧の谷や寒気の影響により曇りで、雨や雪となり雷を伴う所がありますが、高気圧に覆われて次第に晴れとなるでしょう。

＜天気変化等の留意点＞
　２７日１２時から２８日１２時までに予想される１時間降水量は、多い所で、筑後地方で５ミリ、２７日１２時から２８日１２時までに予想される２４時間降水量は、多い所で、筑後地方で１０ミリの見込みです。

GET 以外の HTTP メソッドを使ってアクセスする方法

先ほどはrequests.get()としてリクエストを送りました。

これはサーバーに対して「GET メソッドでリクエストを送る」という指示になるのですが、HTTP メソッドには他にもいくつか種類が存在します。

Web API では、GET または POST を使うことが多いと思います。

別のメソッドが指定されている場合にも、HTTP メソッドと完全に対応する形で requests のメソッドも用意されているのであまり混乱することはないと思います。

リクエスト時に同時に送信できる情報

エンドポイントにアクセスする際に、特定の情報を添付することができます。

添付方法には次のような種類があります。

どの方法でデータを添付するかについては、API ドキュメントなどに書いてあります。

ここではそれぞれ requests ライブラリでどのように情報を送信するかをサクッと解説します。

クエリパラメータ

クエリパラメータをつける場合は、params 引数に辞書を渡します。

# クエリパラメータを定義
params = {
    "city": 400040,
}

response = requests.get(endpoint, params=params)

# クエリパラメータを定義
params = {
    "city": 400040,
}

response = requests.get(endpoint, params=params)

先ほどの天気予報APIでも、クエリパラメータを使ってリクエストを送りました。

リクエストボディ

リクエストボディは、json 引数に辞書を渡します。

# リクエストボディを定義
request_body = {
    "key": "value",
}

response = requests.get(endpoint, json=request_body)

# リクエストボディを定義
request_body = {
    "key": "value",
}

response = requests.get(endpoint, json=request_body)

フォームデータ

ファイルアップロードやフォーム送信には、フォームデータが使われることがあります。

data 引数に辞書を渡してください。

# フォームデータを定義
form_data = {
    "key": "value",
}

response = requests.get(endpoint, data=form_data)

# フォームデータを定義
form_data = {
    "key": "value",
}

response = requests.get(endpoint, data=form_data)

HTTP ヘッダー

HTTP ヘッダーに値を含める場合には、headers 引数に辞書を渡します。

# HTTP ヘッダーを定義
headers = {
    "Authorization": "Bearer YOUR_TOKEN"
}

response = requests.get(endpoint, headers=headers)

# HTTP ヘッダーを定義
headers = {
    "Authorization": "Bearer YOUR_TOKEN"
}

response = requests.get(endpoint, headers=headers)

このような疑問にお答えします。

これまでアプリケーションを作るためにプログラムを書き続けた方は、今回紹介するような少し低レイヤーのソフトウェアを苦手に感じる場合が多いと思います。

僕自身もPythonでデスクトップで動くだけの自動化ソフトばかり作っていた時期には、「Nginxってなんだか難しそうだな…」と漠然としたイメージがありました。

ところがサーバーに触れる機会が増えていくに従って、「あ、なんとなくこんな感じのものなんだな！」という実感が徐々についてくるようになりました。

本記事ではNginxに対して漠然とした恐怖を感じている方に、基礎から実際の運用までを詳しく解説していきます。

書籍で学びたい方は『nginx実践ガイド』はおすすめ。
KindleUnlimitedに加入すれば無料で読めますし、かなり詳しく書かれているのでざっと一読しておくと良いと思います。

Nginx入門: ウェブサーバとは何か？

ウェブサーバーはWebページやWebアプリケーションを配信するシステムです。ブラウザからのリクエストに従って、HTTPSなどのプロトコルで通信します。

また、このようなコンテンツを配信する役割の他にも、セキュリティやパフォーマンス最適化も担当する結構重要な存在です。

Nginxはウェブサーバーの一種

Nginxはウェブサーバーの役割を果たすソフトウェアです。

とはいえ、他にも「ロードバランサの機能がある」だったり「リバースプロキシの機能もある」などと言われますが、これらはウェブサーバーの機能の一部を切り取って表現したものと考えて良いかと思います。

以下に、それぞれの概念をサクッと解説します。

つまり、Nginxは基本的にウェブサーバーとして使われる。
でも、その一部の機能であるリバースプロキシやロードバランサといった単体の機能を切り出して使うこともあると理解すると良いと思います。

Nginxの特徴

Nginxの特徴は以下の通りです。

最近では全世界のウェブサーバーの3分の1がNginxになったと言われていて、シェアとしてはトップクラスです。

このシェアの高さを考えても、Nginxを学んでおく価値は十分にあると思います。

Nginxの内部構造

Nginxは「マスタープロセス」と「ワーカープロセス」の二つで構成されています。

マスタープロセスという親プロセスがいて、その配下に複数のワーカープロセスがぶら下がっているというイメージで考えると良いと思います。

また、ワーカープロセスは複数のクライアントからのリクエストを非同期に処理できるので、システム全体の処理能力を向上することができています。（つまりI/Oを多重化することで処理能力を上げている）

Nginxで使うファイル名と一般的な保存先ディレクトリ

よく使う設定ファイルの場所とファイル名が以下となります。

これらのディレクトリは、nginx周りの設定の際によく使うことになります。

Nginxのインストールと初期設定: 最初の一歩

Nginxのインストールと初期設定について解説します。

パッケージの種類についても必要最低限の内容をさらっと解説していきますので、さらっと目を通してみてください。

パッケージの種類

Nginxには二つのパッケージが用意されています。

Nginxの変更は、まずMainlineに反映されます。
そしてMainlineに取り込まれたもののうち、重大なバグ修正のみがStableに取り込まれる流れです。

毎年4月にメジャーアップデートとしてMainlineからStableに分岐し、同時に古いStable版はサポート終了になります。

新機能を優先するか、安定性を優先するかでどちらかを選択してみてください。

Nginxのインストール

Ubuntu環境では、以下の流れでインストールを行います。

# パッケージリストの更新
sudo apt-get update

# nginxのインストール
sudo apt-get install nginx

# パッケージリストの更新
sudo apt-get update

# nginxのインストール
sudo apt-get install nginx

簡単にインストールする場合にはこれで良いですが、このコマンドでインストールされるのはStable版になります。

また、Ubuntuのリポジトリの場合には最新のStable版とは限らないので、特定のバージョンを使いたい場合にはNginxの公式リポジトリを追加する必要があります。

インストールされたファイルの全体構造

Nginxのインストールによって生成されるファイルの全体構造を見てみましょう。

種類としては意外と少ないので、ざっと眺めて全体感をつかんでおきましょう。

ファイアウォールの設定

ファイアウォールはNginxではなくOS側で設定するものではありますが、必ず設定することになるのでここで説明します。

ここではUbuntuなどで使われるufwコマンドを使った例を示します。

# ufwを有効化する / 外部からのアクセスをすべて閉じる
sudo ufw enable

# HTTP(80), HTTPS(443), SSH(22)を解放する
sudo ufw allow 80
sudo ufw allow 443
sudo ufw allow 22

# ufwの状態や設定を確認する
sudo ufw status

# ufwを有効化する / 外部からのアクセスをすべて閉じる
sudo ufw enable

# HTTP(80), HTTPS(443), SSH(22)を解放する
sudo ufw allow 80
sudo ufw allow 443
sudo ufw allow 22

# ufwの状態や設定を確認する
sudo ufw status

CentOSなど別のOSをお使いの場合には別のコマンドが用意されていることがあります。お使いのOSに合わせて設定を進めて下さい。

ファイアウォールの設定はネットワークセキュリティに直接関わる重要な操作なので、必ず十分に理解した上で行なって下さい。

起動、終了、再起動、設定ファイルの再読み込み

UbuntuやCentOS7以降で使われるsystemdを使ったコマンド例を掲載します。

# 起動
sudo systemctl start nginx

# 終了
sudo systemctl stop nginx

# 再起動
sudo systemctl restart nginx

# 設定ファイルの再読み込み
sudo systemctl reload nginx

# nginxサービスをシステムの起動時に自動的に起動
sudo systemctl enable nginx

# 起動
sudo systemctl start nginx

# 終了
sudo systemctl stop nginx

# 再起動
sudo systemctl restart nginx

# 設定ファイルの再読み込み
sudo systemctl reload nginx

# nginxサービスをシステムの起動時に自動的に起動
sudo systemctl enable nginx

Nginxコマンドの使い方

一般的にはシステムのサービスとしてNginxを管理するために、前にご紹介したsystemctlコマンドを使用するのが推奨されています。

一方、Nginxコマンドを使うとNginxの内部動作に直接影響を与えるので、設定ファイルの構文チェックやログファイルの再オープンなどはnginxコマンドの方が適している場合があります。

# Nginxを起動する("/etc/nginx/nginx.conf"を読み込み)
nginx

# Nginxを即座に停止
nginx -s stop

# Nginxをグレースフルに終了(現在の接続がすべて終了したらNginxを停止)
nginx -s quit

# 設定ファイルを再読み込み
nginx -s reload

# 既存のログファイルを閉じて、新しいログファイルを開く
nginx -s reopen

# 設定ファイルの構文チェック
nginx -t

# Nginxのバージョンを表示
nginx -v

# 別パスにある設定ファイあるを指定してNginxを起動
nginx -c /path/to/file

# Nginxを起動する("/etc/nginx/nginx.conf"を読み込み)
nginx

# Nginxを即座に停止
nginx -s stop

# Nginxをグレースフルに終了(現在の接続がすべて終了したらNginxを停止)
nginx -s quit

# 設定ファイルを再読み込み
nginx -s reload

# 既存のログファイルを閉じて、新しいログファイルを開く
nginx -s reopen

# 設定ファイルの構文チェック
nginx -t

# Nginxのバージョンを表示
nginx -v

# 別パスにある設定ファイあるを指定してNginxを起動
nginx -c /path/to/file

必要に応じてsystemctlコマンドとnginxコマンドを使い分けてみて下さい。

簡単な静的サイトをNginxで構築

Nginxの操作に慣れるには、まず静的なサイトを構成してみるのがおすすめです。

Webアプリケーションのようにユーザー側のリクエストに応じて返すデータが異なると、設定ファイルなどが煩雑になるためです。

基本操作

まずはNginxのインストールと起動を行います。

sudo apt-get update
sudo apt-get install nginx
sudo systemctl start nginx

sudo apt-get update
sudo apt-get install nginx
sudo systemctl start nginx

この状態でWebブラウザからhttp://localhostにアクセスすると、Nginxのデフォルトのウェルカムページが表示されるはずです。/

Webサーバーの構築

HTML、CSS、JavaScriptなどの静的ファイルをサーバー上に配置します。

これらのデータはnginxのルートドキュメントディレクトリ（/var/www/html）に配置して下さい。

設定ファイルの構造

Nginxの主な設定ファイルは/etc/nginx/nginx.confにあります。ところが、個々のサイトの設定は/etc/nginx/sites-available/にあるファイルに書くことが一般的です。

例えばドメインexample.comに対する設定は以下のように書きます。

server {
    # 80番ポート(HTTP)でリクエストを受け付ける
    listen 80;
    # ドメイン名
    server_name example.com;

    location / {
        # リクエストされたURLのファイルがある場所を指定
        root /var/www/example.com;
        # リクエストを受けた時に提供するファイル名
        index index.html;
    }
}

server {
    # 80番ポート(HTTP)でリクエストを受け付ける
    listen 80;
    # ドメイン名
    server_name example.com;

    location / {
        # リクエストされたURLのファイルがある場所を指定
        root /var/www/example.com;
        # リクエストを受けた時に提供するファイル名
        index index.html;
    }
}

ファイル名は分かりやすいものでOKです。例えば、今回はexample.comというウェブサイトの設定なので、/etc/nginx/sites-available/example.comなどとしておけば良いと思います。

なお、Linuxのファイル名では.は特別な意味を持たないので、ドメイン名をそのままファイル名に使うことは一般的です。

また、sites-availableディレクトリに配置した設定ファイルを有効化するには、/etc/nginx/sites-enabled/ディレクトリへのシンボリックリンクを作成します。（つまり、参照先を明示する）

# シンボリックリンク(ショートカットのようなもの)を作成する
sudo ln -s /etc/nginx/sites-available/exapmle.com /etc/nginx/sites-enabled/

# シンボリックリンク(ショートカットのようなもの)を作成する
sudo ln -s /etc/nginx/sites-available/exapmle.com /etc/nginx/sites-enabled/

Nginxでは、デフォルトでsites-enabledディレクトリ内の設定ファイルを読み込みますが、site-availableディレクトリ内は読み込みません。

そのため、Nginxの読み込み対象のディレクトリにシンボリックリンクを配置することで、Nginxの設定対象範囲に含めることになります。

つまり、設定の有効無効をシンボリックリンクの有無で切り替えることができます。

最後に、設定の変更を反映させるためにNginxをリロードします。

sudo systemctl reload nginx

sudo systemctl reload nginx

これで先ほどセットしたページが読み込まれるようになるはずです。

Nginxで実装するアクセス制限

Nginxでは、設定ファイルを使ってさまざまなレベルのアクセス制限を行うことができます。

ちなみにファイアウォールはサーバー自体にアクセスできるかどうかを制御するものであるのに対して、アクセス制限はサーバーに入ってからの権限を細かく設定するという違いがあります。

Basic認証によるアクセス制限

Nginxではユーザー名とパスワードによる認証を利用してアクセス制限することができます。

location / {
    auth_basic "closed site";
    auth_basic_user_file conf/.htpasswd;
}

location / {
    auth_basic "closed site";
    auth_basic_user_file conf/.htpasswd;
}

この場合、ユーザー名とパスワードは.htpasswdファイルに記載することになります。

ここで、htpasswdファイルに暗号化せず平文で記載してしまうと誰かに読まれた時に非常にリスキーです。そのため、ユーザー名・パスワードの登録にあたってはApacheのhtpasswdコマンドなどを使って暗号化しておきます。

# Apacheが未インストールの場合
sudo apt-get install apache2-utils

# 新しいファイルを作成(-cオプションを外すと上書きしない)
sudo htpasswd -c /etc/nginx/.htpasswd username

# Apacheが未インストールの場合
sudo apt-get install apache2-utils

# 新しいファイルを作成(-cオプションを外すと上書きしない)
sudo htpasswd -c /etc/nginx/.htpasswd username

ただ、ここまでの例ではHTTPプロトコルによるアクセスを前提にしてきたため、このBasic認証を設定した場合には第三者に通信が傍受されてIDやパスワードが盗まれてしまう場合があります。（認証情報はBase64エンコードで送信されるので、簡単にデコードできるため）

これを避ける方法としては、HTTPではなくHTTPSで通信する方法があります。

場合によってはOAuthやJWTなどのより安全性の高い認証方法を検討しましょう。

IPアドレスによるアクセス制限

本来であればファイアウォールで制御するIPアドレスごとの許可・不許可も、Nginxのアクセス制限を使うことでIPアドレスごとの制御ができます。

location / {
    deny   <deny ip address>;
    allow  <allow ip address>;
    deny   all;
}

location / {
    deny   <deny ip address>;
    allow  <allow ip address>;
    deny   all;
}

実際には会員専用ページなど、特定の人にしか見せたくないページの設定をする際に便利な機能かと思います。

location /secret-page {
    deny all
    allow <allow ip address>;
    root /var/www/html/secret;
    index index.html
}

location /secret-page {
    deny all
    allow <allow ip address>;
    root /var/www/html/secret;
    index index.html
}

この場合、許可されているIPアドレス以外からのアクセスでは、403 ForbiddenというHTTPステータスコードが表示されてアクセスができません。

動的なWebアプリをNginxで構築する方法

一つ前のセクションでは静的サイトの構成をご紹介しましたが、ここでは一歩進んで動的なWebアプリケーションの構成を考えてみます。

WebアプリケーションとWebサーバーの接続方法

動的なWebアプリケーションを動作させたい場合には、次のような通信方式によりアプリケーションサーバーと通信させます。

例えばDjangoを触り慣れている方であればuwsgiはごく見慣れたプロトコルだと思います。

Webアプリケーションの設定によく使われる機能

Nginxをウェブサーバーとして使用する際、Webアプリケーションの設定によく使われる機能には以下のようなものがあります。

FlaskアプリとuWSGIの設定方法を解説

具体的な例として、FlaskアプリケーションとuWSGIが通信できるような設定をしてみましょう。

例えば、Flaskアプリの内容を次のようにしたとしましょう。

from flask import Flask
app = Flask(__name__)

@app.route("/")
def hello_world():
    return "Hello, World!"

from flask import Flask
app = Flask(__name__)

@app.route("/")
def hello_world():
    return "Hello, World!"

これをuWSGIで動かすために、次のようなuWSGI設定ファイルを作成します。

[uwsgi]
module = app:app
master = true
processes = 5
socket = app.sock
chmod-socket = 660
vacuum = true
die-on-term = true

[uwsgi]
module = app:app
master = true
processes = 5
socket = app.sock
chmod-socket = 660
vacuum = true
die-on-term = true

module = app:appとすることで、app.pyのappオブジェクトをアプリケーションとして使うことを示しています。

この設定ファイルを元にuWSGIを起動するには、次のコマンドを実行します。

uwsgi --ini app.ini

uwsgi --ini app.ini

このコマンドを実行することで、app.sockというUNIXソケットが作成されて、uWSGIとFlaskアプリケーションの間の通信ができるようになりました。

続いてNginxの設定です。

server {
    listen 80;
    server_name example.com;
    location / {
        include uwsgi_params;
        uwsgi_pass unix:/path/to/your/app.sock;
    }
}

server {
    listen 80;
    server_name example.com;
    location / {
        include uwsgi_params;
        uwsgi_pass unix:/path/to/your/app.sock;
    }
}

uwsgi_passディレクティブには、先ほどapp.iniで指定したsocketとして指定したファイルパスを指定します。

最後にNginxにこの設定を有効化するため、シンボリックリンクの作成と再起動をするコマンドを実行します。

sudo ln -s /etc/nginx/sites-available/app /etc/nginx/sites-enabled/
sudo service nginx restart

sudo ln -s /etc/nginx/sites-available/app /etc/nginx/sites-enabled/
sudo service nginx restart

以上で、Nginxは80ポートで受け取ったHTTPリクエストをUNIXソケットを通じてuWSGIに転送できるようになるはずです。

HTTPSを使ったセキュアな接続

HTTPSは、HTTPの問題点だったセキュリティの脆弱性を改善した通信方法です。

最近ではGoogleがHTTPS対応していないサイトに対して警告を出すなどペナルティを課しているので、最近ではHTTPS対応は必須になってきました。ここでは、このHTTPSをNginxで使うための基礎知識を共有します。

SSL/TLSについて知ろう

SSL（Secure Sockets Layer）と、その後継規格のTLS（Transport Layer Security）は、インターネット上でデータ暗号化して傍受されても大丈夫なように送受信するプロトコルです。

HTTPS（HTTP over SSL/TLS）はこの技術を使っているので、ウェブブラウザとウェブサーバー間の通信は暗号化されます。例えばクレジットカード番号やパスワードなどの機密情報を盗まれることのないよう、HTTPS通信でやり取りされるのが基本です。

証明書の取得方法

サーバー証明書は認証局から取得していくことになります。

これまではサーバー証明書を取得するには費用が必要でしたが、Let’s Encryptなどの認証局を使うことで無料で証明書の発行をしてもらえることもできます。

証明書を取得するには、まずCSR（Certificate Signing Request）というファイルを生成した上で、これを認証局に提出し、証明書を取得する流れとなります。

CSRには「ドメイン名」や「組織名」などが書かれており、このファイルを元に認証局がサイトの正当性を審査することになります。

ちなみに、証明書を取得する目的は大きく「正しいウェブサイトであること」と「データが改ざんされていないこと」の2つです。

nginxにサーバー証明書を設定しよう

証明書を取得したら、それをNginxに設定することでHTTPSを有効化します。

server {
    listen 443 ssl;
    server_name example.com;

    # 証明書のパスを指定
    ssl_certificate /etc/nginx/ssl/example.com.crt;
    # 秘密鍵のパスを指定
    ssl_certificate_key /etc/nginx/ssl/example.com.key;
}

server {
    listen 443 ssl;
    server_name example.com;

    # 証明書のパスを指定
    ssl_certificate /etc/nginx/ssl/example.com.crt;
    # 秘密鍵のパスを指定
    ssl_certificate_key /etc/nginx/ssl/example.com.key;
}

上記の方法では/etc/nginx/conf.d/ディレクトリにファイルを格納しているので、sites-availableディレクトリに格納する場合と違ってシンボリックリンクを作成する必要はありません。（conf.dディレクトリはNignxが自動的に読み込むため）

HTTPからHTTPSへの自動リダイレクトをするには、以下を書きます。

server {
    listen 80;
    server_name example.com;

    location / {
        return 301 https://$host$request_uri;/
    }
}

server {
    listen 80;
    server_name example.com;

    location / {
        return 301 https://$/host$request_uri;
    }
}

ちなみにLet’s Encryptを使った証明書の取得と設定に関しては、簡単なコマンドの実行で取得が完了するので便利です。

sudo certbot --nginx -d example.com -d www.example.com

sudo certbot --nginx -d example.com -d www.example.com

--nginxフラグを使うことでサーバー設定を自動的に行ってくれます。また、サーバー証明書を取得するだけでなく、証明書の自動更新も設定してくれます。

-dフラグに続けて、証明書を取得するドメイン名を指定してください。

ちなみにLets Encryptの証明書は一般に公開されている状態でないと発行されませんので注意が必要です。

トラブルシューティングとメンテナンス

Nginxではなんらかのタイミングでエラーが発生したり、予期せぬエラーが発生しないようにメンテナンスをする必要があります。

ここではログファイルの役割や調べ方、基本的なメンテナンスについてお伝えしていきます。

Nginxのログファイル

Nginxのログファイルには、アクセスログとエラーログの二つがあります。

アクセスログ

サーバーへの全てのリクエストについて、次のような情報を記録します。

サイト訪問者の行動を分析したり、エラーの原因調査に使います。

エラーログ

次のようなサーバーのエラー情報を記録します。

これらのログはデフォルトで/var/log/nginx/ディレクトリ内に記録されていきます。

メンテナンスの考え方

Nginxの基本的なメンテナンスをまとめると次のようなものがあります。

まとめ

以上、Nginxの基本的な知識を一つの記事にまとめてみました。全体のイメージはつきましたでしょうか？

ご覧の通り、Nginxを理解するための鍵は設定ファイルにあります。

簡単なWebサイトからconfファイルの内容を理解しつつ、少しずつ複雑なサイトにも対応できるようになっていきましょう。

冒頭でも紹介しましたが、Nginxの全体像を知る上で『Nginx 実践ガイド』はおすすめです。
Kindle Unlimitedなら無料で読めちゃいますので、気になった方はざっとで良いので目を通してみましょう。

Pandas は内部的に C 言語で最適化されているので、Python の CSV モジュールなどと比べても超高速に動作します。

また、Pandas で使われる DataFrame には痒いところに手が届くようなメソッドが多数実装されているので、少ないコード量でデータ分析ができる超便利なライブラリです。

とはいえ DataFrame はコードの書き方にやや癖があるので、苦手意識やとっつきにくさを感じている方も多いと思います。

本記事ではPandasの基本操作をシンプルにご紹介していきます。

DataFrame として読み込む

すでにあるデータから DataFrame として読み込む方法から紹介します。

ここで取得した DataFrame オブジェクトに対して加工・集計を行なっていくことになるのでファーストステップですね。

引数にパラメーターを与えることで色々できますので、基本の使い方 => 応用的な使い方までご紹介します。

Excel ブック

ただ単に Excel ブックを読み込みたい場合は以下のコードです。

excel_path = 'new_book.xlsx'
sheet_name = 'Sheet1'

# Excel => DataFrame
df = pd.read_excel(excel_path, sheet_name=sheet_name)

excel_path = 'new_book.xlsx'
sheet_name = 'Sheet1'

# Excel => DataFrame
df = pd.read_excel(excel_path, sheet_name=sheet_name)

DataFrame として読み込む場合にはシートを指定することに注意してください。（CSVはシートという概念がないのでsheet_nameがない）

エンコードの関係で文字化けする場合には、encoding引数でオプションを設定します。

excel_path = 'new_book.xlsx'
sheet_name = 'Sheet1'

# Excel => DataFrame
df = pd.read_excel(excel_path, sheet_name=sheet_name, encoding='utf-8_sig')

excel_path = 'new_book.xlsx'
sheet_name = 'Sheet1'

# Excel => DataFrame
df = pd.read_excel(excel_path, sheet_name=sheet_name, encoding='utf-8_sig')

基本的にはutf-8_sigでいけますが、それでもダメな場合はANSIやcp932を使ってみましょう。色々試してみてください。

CSV ファイル

CSVファイルを読み込む方法です。

csv_path = 'somefile.csv'

# CSV => DataFrame
df = pd.read_CSV(csv_path, encoding="utf-8_sig")

csv_path = 'somefile.csv'

# CSV => DataFrame
df = pd.read_CSV(csv_path, encoding="utf-8_sig")

CSVファイルは文字化けの問題が多いので、基本的にはencodingで指定します。

データ整形

キーワードで絞り込み

基本的なデータの絞り込み方法は以下の通りです。

# 青森県を取得
df["都道府県"] = df[df["都道府県"] == "青森県"]

# 青森県を取得
df["都道府県"] = df[df["都道府県"] == "青森県"]

df["都道府県"] == "青森県"の部分ではTrueかFalseのブール値が得られますので、これを外からdfで囲むとTrueのものだけが抽出できるというわけです。

逆にFalseのものだけで抽出したい場合には、以下のように~（チルダ）をつけます。

# 青森県以外を取得
df["都道府県"] = df[~df["都道府県"] == "青森県"]

# 青森県以外を取得
df["都道府県"] = df[~df["都道府県"] == "青森県"]

数値で絞り込む

キーワードでの絞り込みと同様に、数値を比較演算子で繋げることで条件に合ったレコードを取得できます。

# 得点が80点以上のレコードを取得
df["得点"] = df[df["得点"] <= 80]

# 得点が80点以上のレコードを取得
df["得点"] = df[df["得点"] <= 80]

あるキーワードを含むレコードで絞り込む

isinメソッドを使うことで「含む」を表現できます。

# 「県」を含むレコードを取得
df["都道府県"] = df[df["都道府県"].isin(["県"])]

# 「県」を含むレコードを取得
df["都道府県"] = df[df["都道府県"].isin(["県"])]

もちろん、「含まない」ということを表現する場合は~をつけることで実装可能です。

# 「県」を含むレコードを取得
df["都道府県"] = df[~df["都道府県"].isin(["県"])]

# 「県」を含むレコードを取得
df["都道府県"] = df[~df["都道府県"].isin(["県"])]

日時の操作

datetime型に変換する

日時に関するデータを読み込んだはずが文字列型で読み込まれていることがあります。

そんな時は、to_datetimeメソッドを使いましょう。

df["日時"] = pd.to_datetime(df["日時"])

df["日時"] = pd.to_datetime(df["日時"])

timedelta型に変換する

時間計算などする場合にはtimedelta型に変換しておくと便利です。

df["時間"] = pd.to_timedelta(df["時間"])

df["時間"] = pd.to_timedelta(df["時間"])

年 / 月 / 日だけを抽出する

年・月・日など単体で要素を取り出したい場合、dtアクセサを使うとうまく抽出できます。

# 年だけ抽出
df["年"] = df["日時"].dt.year
# 月だけ抽出
df["月"] = df["日時"].dt.month
# 日だけ抽出
df["日"] = df["日時"].dt.day

# 年だけ抽出
df["年"] = df["日時"].dt.year
# 月だけ抽出
df["月"] = df["日時"].dt.month
# 日だけ抽出
df["日"] = df["日時"].dt.day

日時で丸め / 切り捨て / 切り上げ

datetime型はミリ秒単位で情報があるとかえって扱いが煩雑になってしまうことがあるので、必要な範囲でデータを削ぎ落としておくと扱いがラクになります。

dtアクセサを使ってdatetimeっぽい形で編集できるようにするのがポイントです。

# 日時の丸め
df["日時"] = df["日時"].dt.round(freq="D")  # 日
df["日時"] = df["日時"].dt.round(freq="H")  # 時間
df["日時"] = df["日時"].dt.round(freq="15T")  # 15分

# 日時の切り捨て
df["日時"] = df["日時"].dt.floor(freq="D")  # 日
df["日時"] = df["日時"].dt.floor(freq="H")  # 時間
df["日時"] = df["日時"].dt.floor(freq="15T")  # 15分

# 日時の切り捨て
df["日時"] = df["日時"].dt.ceil(freq="D")  # 日
df["日時"] = df["日時"].dt.ceil(freq="H")  # 時間
df["日時"] = df["日時"].dt.ceil(freq="15T")  # 15分

# 日時の丸め
df["日時"] = df["日時"].dt.round(freq="D")  # 日
df["日時"] = df["日時"].dt.round(freq="H")  # 時間
df["日時"] = df["日時"].dt.round(freq="15T")  # 15分

# 日時の切り捨て
df["日時"] = df["日時"].dt.floor(freq="D")  # 日
df["日時"] = df["日時"].dt.floor(freq="H")  # 時間
df["日時"] = df["日時"].dt.floor(freq="15T")  # 15分

# 日時の切り捨て
df["日時"] = df["日時"].dt.ceil(freq="D")  # 日
df["日時"] = df["日時"].dt.ceil(freq="H")  # 時間
df["日時"] = df["日時"].dt.ceil(freq="15T")  # 15分

roundに渡す引数freqはかなりの数が用意されているので、目的に合わせて公式ドキュメントを参照してみましょう。

» 参考：pandas Offset aliases

まとめ

Python でデータを扱う場合に比べてややクセはありますが、Pandas なら高速に少ないコード量でやりたいことが実現できます。

習得までには少し時間がかかるかもしれませんが、データを扱う場合に大きな力になってくれるライブラリです。

ぜひ、スラスラと書けるようになるまで使い込んでみてください。

このような方に向けて書きました。

Webのお仕事をしていると、当然のように触れるSSH接続。

なんとなく苦手意識を持っている方は多いのではないでしょうか？

本記事ではSSH接続がどんなものかと、実務でよく使うコマンドを解説します。

読了後にはSSH接続の仕組みはざっくり説明できるレベルになっているはずです。

ぜひ、この機会に基礎をマスターしていきましょう！

まずはSSH接続の概要を理解しよう！

SSH（Secure Shell）は、コンピュータ同士がやりとりをする方法の一つです。

このやりとりの方法は、「プロトコル」と呼ばれます。

SSH接続はサーバとの通信で使われる

結論、SSH接続はサーバーとの通信でよく使われます。

たとえば新しくサーバーをレンタルしても、接続できなければ何の操作もできません。

SSH接続を使うことで、手元のPCとサーバーの間でデータのやりとりができるようになります。

しかも、これらの通信はセキュリティで保護されます。

以前はTelnetやRloginといったものが使われていましたが、近年ではセキュリティが強化されたSSHを使うことが多くなりました。

２種類の接続方法

SSH接続には、２種類の接続方法があります。

パスワード認証方式は、ユーザー名とパスワードでログインする方法です。

パスワードを知っていればどの端末からでもアクセスできる手軽さがある一方、パスワードが漏れてしまった場合には簡単に不正ログインされてしまいます。

一方の公開鍵認証方式は、2種類の鍵（公開鍵と秘密鍵のペア）を使って「パスワードなし」でログインできる方法になります。

この方法は、鍵がないとログインできないのでセキュリティが高いと言われています。

ただし設定がやや面倒なのと、秘密鍵自体を盗まれた時に不正ログインリスクが上がってしまうというデメリットもあります。

CFXLOG

SSH接続では、このどちらかの方法を使ってログインします。

公開鍵認証方式について簡単に説明

公開鍵方式で理解しておくべきは、次の2点です。

実務的には、まずこれだけ覚えておけば大丈夫です。

公開してはいけないのは、その名の通り「秘密鍵」の方です。

一方でばら撒いておくのが「公開鍵」となります。

SSH接続でサーバーと通信する方法

ここからは実際にサーバーとSSH接続してみましょう。

まずはパスワード方式と公開鍵方式の基本的な手順を解説します。

パスワード方式を使った接続方法

初めてサーバーにログインする場合は、次のsshコマンドを実行しましょう。

# IPアドレスでログインする場合の具体例
ssh ユーザー名@IPアドレス

# IPアドレスでログインする場合の具体例
ssh ユーザー名@IPアドレス

実行後にパスワードを聞かれるので、入力したらログイン完了です。

ちなみに「ユーザー名」と「IPアドレス」は、契約したサーバーのマイページなどに記載があります。

職場のアカウントでこれらが不明なら、システム管理者に問い合わせてください。

WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED!というメッセージが表示された場合は、こちらを参照してください。

公開鍵方式を使った接続方法

公開鍵方式は次の手順で進めます。

手順を踏んでいけば何となくわかるので、一つずつ進めていきましょう。

1. キーペアを作る

公開鍵方式では「秘密鍵」と「公開鍵」のペア（キーペア）が必要です。

このキーペアを作るために、次のコマンドを実行します。

ssh-keygen -t rsa -b 4096 -C "youremail@example.com"

ssh-keygen -t rsa -b 4096 -C "youremail@example.com"

youremail@example.comの部分は、あなたのメールアドレスに置き換えましょう。

これを実行すると、生成する鍵のファイル名とパスを聞かれます。

% ssh-keygen -t rsa -b 4096 -C "********@gmail.com"
Generating public/private rsa key pair.
Enter file in which to save the key (/Users/user/.ssh/id_rsa): 

% ssh-keygen -t rsa -b 4096 -C "********@gmail.com"
Generating public/private rsa key pair.
Enter file in which to save the key (/Users/user/.ssh/id_rsa): 

ここは、何も入力せずにEnterを押していきましょう。
上記では/Users/user/.ssh/id_rsaがデフォルトになっているので、このパスに保存されます。

すると上記のように、パスフレーズを設定するかどうか聞かれます。

% ssh-keygen -t rsa -b 4096 -C "********@gmail.com"
Generating public/private rsa key pair.
Enter file in which to save the key (/Users/user/.ssh/id_rsa):
Enter passphrase (empty for no passphrase): 

% ssh-keygen -t rsa -b 4096 -C "********@gmail.com"
Generating public/private rsa key pair.
Enter file in which to save the key (/Users/user/.ssh/id_rsa):
Enter passphrase (empty for no passphrase): 

パスフレーズを設定すると、公開鍵認証でもログイン時にパスフレーズの入力も求められます。

つまり、秘密鍵を盗んだ第三者が不正アクセスしづらくなります。

セキュリティ的には設定するに越したことはないですが、ログインのたびに毎回パスフレーズを聞かれるのが面倒ならパスフレーズなしで設定を進めることもできます。

今回はごく簡単なケースとして、パスフレーズなしにしましょう。
なので、何も入力せずにEnterを押してください。

すると、もう一度パスフレーズの入力を求められるので、何も入力せずにEnterとしましょう。

% ssh-keygen -t rsa -b 4096 -C "********@gmail.com"
Generating public/private rsa key pair.
Enter file in which to save the key (/Users/user/.ssh/id_rsa):
Enter passphrase (empty for no passphrase): 
Enter same passphrase again: 

% ssh-keygen -t rsa -b 4096 -C "********@gmail.com"
Generating public/private rsa key pair.
Enter file in which to save the key (/Users/user/.ssh/id_rsa):
Enter passphrase (empty for no passphrase): 
Enter same passphrase again: 

最後に以下のlsコマンドを実行して、鍵が生成されたかを確認しましょう。

% ls -la ~/.ssh 
drwxr-xr-x  10 user  staff   320 10 10 07:37 .
drwxr-x---+ 21 user  staff   672 10 10 19:32 ..
-r--------@  1 user  staff   464 10  6 14:14 id_rsa
-rw-rw-r--@  1 user  staff   102 10  6 14:14 id_rsa.pub

% ls -la ~/.ssh 
drwxr-xr-x  10 user  staff   320 10 10 07:37 .
drwxr-x---+ 21 user  staff   672 10 10 19:32 ..
-r--------@  1 user  staff   464 10  6 14:14 id_rsa
-rw-rw-r--@  1 user  staff   102 10  6 14:14 id_rsa.pub

2つの鍵が生成されていることが確認できました。

pubとついていないものが秘密鍵なので、これは外部に公開しないように注意しましょう。

2. 公開鍵をサーバーに置く

続いて公開鍵をサーバーに登録します。

次のコマンドを実行してください。

ssh-copy-id -i ~/.ssh/id_rsa.pub ユーザー名@サーバーアドレス

ssh-copy-id -i ~/.ssh/id_rsa.pub ユーザー名@サーバーアドレス

これにより、サーバーの~/.ssh/authorized_keysファイルに公開鍵が保存されます。

すでに他の公開鍵が登録されていたとしても、上書きではなく追記になるのでご安心ください。

もしssh-copy-idコマンドが使えないなら、次の手順で公開鍵を登録できます。

# 1.公開鍵の内容をクリップボードにコピー
cat ~/.ssh/id_rsa.pub | pbcopy

# 2.サーバーにログイン
ssh ユーザー名@サーバーアドレス

# 3.公開鍵を追記
echo "ssh-rsa AAAAB3...（ここに貼り付け）" >> ~/.ssh/authorized_keys

# 1.公開鍵の内容をクリップボードにコピー
cat ~/.ssh/id_rsa.pub | pbcopy

# 2.サーバーにログイン
ssh ユーザー名@サーバーアドレス

# 3.公開鍵を追記
echo "ssh-rsa AAAAB3...（ここに貼り付け）" >> ~/.ssh/authorized_keys

3. sshコマンドでログインする

いずれかの方法でサーバーに公開鍵の登録ができたら、SSH接続でログインしましょう。

次のコマンドを実行します。

ssh ユーザー名@サーバーアドレス

ssh ユーザー名@サーバーアドレス

パスフレーズを設定した場合にはパスフレーズの入力を求められます。

WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED!というメッセージが表示された場合は、こちらを参照してください。

知っておくと便利な設定方法

SSH接続をさらに便利にする設定をご紹介します。

それぞれ解説します。

パスフレーズの入力を省略する方法

秘密鍵にパスフレーズを設定すると、毎回のSSH接続時にパスフレーズの入力が必要になります。

セキュリティは高くなるものの、サーバーに頻繁に接続するとなると少し面倒。

そこで活用したいのが ssh-agent です。

ssh-agentを使えば、パスフレーズ付きの秘密鍵を一時的に記憶してくれるので、何度も入力せずに済むようになります。

使い方は以下の通り。

# エージェントを起動（1回だけ）
eval "$(ssh-agent -s)"

# 鍵を登録（1回パスフレーズを聞かれる）
ssh-add ~/.ssh/id_rsa

# 以降はこのセッション中、パスフレーズ不要でSSH接続できる
ssh user@host

# エージェントを起動（1回だけ）
eval "$(ssh-agent -s)"

# 鍵を登録（1回パスフレーズを聞かれる）
ssh-add ~/.ssh/id_rsa

# 以降はこのセッション中、パスフレーズ不要でSSH接続できる
ssh user@host

SSHエージェントはPCのメモリ上に「一時的に」パスフレーズ付きの鍵を保持します。

なので、ターミナルを閉じたり、PCを再起動するなどしてセッションが切れると、再度ssh-addコマンドの実行が必要になります。

SSHフォワーディング

SSHフォワーディングとは、あるサーバー（例：server1）にログインした状態から、自分のPCにある秘密鍵（ローカルのSSHエージェント）を経由して、さらに別のサーバー（例：server2）に接続する方法です。

あらかじめ、ローカルのSSHエージェントに、最終接続先であるserver2の秘密鍵を登録します。

eval "$(ssh-agent -s)"
ssh-add ~/.ssh/server2

eval "$(ssh-agent -s)"
ssh-add ~/.ssh/server2

続いてserver1に対して-AオプションをつけてSSH接続します。

ssh -A server1

ssh -A server1

こうしておくと、server1に秘密鍵を設置しなくとも、ローカルにある秘密鍵を使ってserver2にログインできるようになります。

つまり、server1にいる状態でローカルのSSHエージェントが使えるようになるわけです。

SSHのトラブルシューティング

SSHに問題が起こった場合の解決方法をご紹介します。

変な警告メッセージが表示されてログインできない

ログイン時に以下のメッセージが表示されることがあります。

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@    WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED!     @
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!
Someone could be eavesdropping on you right now (man-in-the-middle attack)!
It is also possible that a host key has just been changed.
The fingerprint for the ED25519 key sent by the remote host is
SHA256: <some key>
Please contact your system administrator.
Add correct host key in /Users/username/.ssh/known_hosts to get rid of this message.
Offending ED25519 key in /Users/username/.ssh/known_hosts:5
Host key for <IPADDRESS> has changed and you have requested strict checking.
Host key verification failed.

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@    WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED!     @
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!
Someone could be eavesdropping on you right now (man-in-the-middle attack)!
It is also possible that a host key has just been changed.
The fingerprint for the ED25519 key sent by the remote host is
SHA256: <some key>
Please contact your system administrator.
Add correct host key in /Users/username/.ssh/known_hosts to get rid of this message.
Offending ED25519 key in /Users/username/.ssh/known_hosts:5
Host key for <IPADDRESS> has changed and you have requested strict checking.
Host key verification failed.

このメッセージの原因は大きく3つに分けられます。

それぞれの対策方法を説明します。

❶または❷の場合

ローカルのホストキーが古いためのエラーで、特に危険はありません。

以下のコマンドを使ってホストキーを削除しましょう。

ssh-keygen -R <IPADDRESS>

ssh-keygen -R <IPADDRESS>

これで再度sshコマンドを実行すれば、普通にログインができるはずです。

❸の場合

この場合は、絶対にログインしないでください。

この危険性を理解するために、まずはSSH接続のたびに行われていることを理解する必要があります。

最初に示した警告が表示されるのは❸の段階です。

ホストキーの不一致に心当たりがない場合には、最悪の場合サーバーが攻撃を受けている可能性があります。

早めにサーバーの管理者に報告するようにして下さい。

接続が拒否される

SSH接続が拒否されると、次のようなメッセージが返ってきます。

ssh: connect to host [ホスト名 or IPアドレス] port 22: Connection refused

ssh: connect to host [ホスト名 or IPアドレス] port 22: Connection refused

接続が拒否されてしまう場合にの原因と対策は次の通りです。

基本的にはサーバーの管理者に連絡して指示を仰ぎましょう。

たまにファイアウォールの設定を誤ってしまい、自分が締め出されてしまう場合もあります。

どうしても入れなくなってしまった場合には、OSを再インストールしましょう。

公開鍵が正しく認識されない

サーバーに登録した公開鍵が認識されていない場合もあります。

このような場合にはサーバーからメッセージが返ってくることはありません。

なぜなら、ここで具体的なメッセージが返ってきてしまうと不正アクセスの手助けをすることになってしまうからです。

管理者権限でログインできれば、SSHログを参照して詳細を確認できます。

sudo less /var/log/auth.log
# Authentication refused: bad ownership or modes for directory /home/username/.ssh

sudo less /var/log/auth.log
# Authentication refused: bad ownership or modes for directory /home/username/.ssh

たとえば上記の場合、~/.sshディレクトリまたはその中のファイル（例えばauthorized_keys）のパーミッションが間違っていることがわかります。

その他に考えられる主な原因と対策は次の通りです。

権限設定は、.sshディレクトリは700、authorized_keysは600に設定することが一般的です。

chmod 700 ~/.ssh
chmod 600 ~/.ssh/authorized_keys

chmod 700 ~/.ssh
chmod 600 ~/.ssh/authorized_keys

まとめ

SSHはサーバーとの通信になくてはならない技術です。

また、一口にSSH接続といっても二種類の認証方法があるのでした。

一般的にはセキュリティの高い公開鍵方式が採用されます。

公開鍵方式ではパスワードなしでログインできるようになりますが、セキュリティ強化のためにパスフレーズが設定されることもあります。

公開鍵方式は初期設定が少し面倒なので、本記事の内容を参考に手順を覚えていっていただけたら幸いです。