Skip to content
PDF Oxide

PDF-библиотека для Go — PDF Oxide

PDF Oxide — самая быстрая PDF-библиотека для Go: 0,8 мс на страницу в среднем, в 5 раз быстрее PyMuPDF, в 15 раз быстрее pypdf, 100 % успеха на 3 830 PDF. Один модуль для извлечения, создания и редактирования. Чтение безопасно между goroutine через sync.RWMutex. Лицензия MIT / Apache-2.0.

Установка

go get github.com/yfedoseev/pdf_oxide/go
go run github.com/yfedoseev/pdf_oxide/go/cmd/install@latest

Требования: Go 1.21+ с включённым CGo (CGO_ENABLED=1, значение по умолчанию).

Начиная с v0.3.31 нативный FFI-архив загружается по запросу, а не хранится в модуле. Команда install скачивает tarball под вашу платформу (~26 МБ) в ~/.pdf_oxide/v<version>/, проверяет SHA-256 против опубликованного .sha256 и печатает значения CGO_CFLAGS и CGO_LDFLAGS, которые нужно экспортировать. Укажите --write-flags=<dir>, чтобы вместо экспорта переменных окружения рядом с вашим кодом был создан файл cgo_flags.go. Запускать достаточно один раз на машину — @latest сам определяет нужный релиз через runtime/debug.ReadBuildInfo.

Биндинг связывает Rust-ядро как статическую библиотеку, поэтому итоговый Go-бинарник полностью самодостаточен: ни LD_LIBRARY_PATH, ни DYLD_LIBRARY_PATH, ни PATH настраивать во время выполнения не нужно. Просто go build — и готовое приложение можно выкладывать.

Монорепозиторий или сборка из исходников: добавьте -tags pdf_oxide_dev, чтобы CGo ссылался на локальный target/release/libpdf_oxide.a. Инсталлятор при этом не нужен.

Обновление с v0.3.30 или раньше: закоммиченные нативные архивы в go/lib/ удалены. Первая сборка go build после обновления упадёт на линковке (undefined reference to pdf_document_open ...), пока вы один раз не запустите go run github.com/yfedoseev/pdf_oxide/go/cmd/install@latest и не экспортируете напечатанные переменные CGO_* (или не запишете их через --write-flags).

Платформы с готовыми бинарниками: Linux x64/arm64, macOS x64/arm64 (Apple Silicon), Windows x64 (через x86_64-pc-windows-gnu).

Открытие PDF

package main

import (
    "fmt"
    "log"

    pdfoxide "github.com/yfedoseev/pdf_oxide/go"
)

func main() {
    doc, err := pdfoxide.Open("research-paper.pdf")
    if err != nil {
        log.Fatal(err)
    }
    defer doc.Close()

    count, _ := doc.PageCount()
    major, minor, _ := doc.Version()
    fmt.Printf("%d страниц, PDF %d.%d\n", count, major, minor)
}

API страниц

С версии v0.3.34 можно работать на уровне страниц. doc.Page(i) возвращает лёгкий *Page-хэндл, делегирующий вызовы родительскому документу.

page, _ := doc.Page(0)
text, _ := page.Text()
md, _   := page.Markdown()

pages, _ := doc.Pages()
for _, p := range pages {
    t, _ := p.Text()
    fmt.Printf("--- Страница %d ---\n%s\n", p.Index+1, t)
}

Каждый Page предоставляет Text(), Markdown(), Html(), PlainText(), Chars(), Words(), Lines(), Tables(), Images(), Paths(), Fonts(), Annotations(), Info(), Search(), NeedsOcr() и TextWithOcr().

Извлечение текста

Одна страница

text, err := doc.ExtractText(0)
if err != nil {
    log.Fatal(err)
}
fmt.Println(text)

Все страницы

allText, err := doc.ExtractAllText()
if err != nil {
    log.Fatal(err)
}
fmt.Println(allText)

Ручной обход страниц

pages, _ := doc.Pages()
for _, p := range pages {
    text, err := p.Text()
    if err != nil {
        log.Printf("страница %d: %v", p.Index, err)
        continue
    }
    fmt.Printf("--- Страница %d ---\n%s\n", p.Index+1, text)
}

Структурированное извлечение

words, _  := doc.ExtractWords(0)        // []Word
lines, _  := doc.ExtractTextLines(0)    // []TextLine
chars, _  := doc.ExtractChars(0)        // []Char
tables, _ := doc.ExtractTables(0)       // []Table — строки и ячейки с bbox (v0.3.34)
paths, _  := doc.ExtractPaths(0)        // []Path

for _, w := range words {
    fmt.Printf("%q в (%.1f, %.1f)\n", w.Text, w.X, w.Y)
}

for _, t := range tables {
    fmt.Printf("%dx%d (заголовок=%v)\n", t.RowCount, t.ColCount, t.HasHeader)
    for r := 0; r < t.RowCount; r++ {
        for c := 0; c < t.ColCount; c++ {
            fmt.Printf("%s\t", t.CellText(r, c))
        }
        fmt.Println()
    }
}

Извлечение по области:

region, _ := doc.ExtractTextInRect(0, 50, 700, 200, 50) // x, y, ширина, высота
words, _  := doc.ExtractWordsInRect(0, 50, 700, 200, 50)

Конвертация в Markdown

md, err := doc.ToMarkdown(0)
if err != nil {
    log.Fatal(err)
}
fmt.Println(md)

// Все страницы
allMd, _ := doc.ToMarkdownAll()

Конвертация в HTML

html, _  := doc.ToHtml(0)
allHtml, _ := doc.ToHtmlAll()

Извлечение изображений

import "os"

images, err := doc.Images(0)
if err != nil {
    log.Fatal(err)
}

for i, img := range images {
    fmt.Printf("Изображение %d: %dx%d %s %s %dbpc (%d байт)\n",
        i, img.Width, img.Height, img.Format, img.Colorspace, img.BitsPerComponent, len(img.Data))
    os.WriteFile(fmt.Sprintf("image_%d.%s", i, img.Format), img.Data, 0644)
}

Открытие из байтов и Reader

// Из байтов
data, _ := os.ReadFile("document.pdf")
doc, err := pdfoxide.OpenFromBytes(data)

// Из произвольного io.Reader
doc, err := pdfoxide.OpenReader(someReader)

// С паролем
doc, err := pdfoxide.OpenWithPassword("secure.pdf", "user-password")

Создание PDF

// Из Markdown
pdf, _ := pdfoxide.FromMarkdown("# Привет\n\nОсновной текст.")
defer pdf.Close()
pdf.Save("out.pdf")

// Из HTML
htmlPdf, _ := pdfoxide.FromHtml("<h1>Счёт</h1><p>Сумма: $42</p>")
defer htmlPdf.Close()
htmlPdf.Save("invoice.pdf")

// Из текста
txt, _ := pdfoxide.FromText("Простой текстовый документ.")
defer txt.Close()

// Из изображения
img, _ := pdfoxide.FromImage("photo.jpg")
defer img.Close()

// Объединение нескольких PDF
merged, _ := pdfoxide.Merge([]string{"a.pdf", "b.pdf"})
os.WriteFile("merged.pdf", merged, 0644)

Рендеринг

// Формат: 0 = PNG, 1 = JPEG
img, err := doc.RenderPage(0, 0)
if err != nil {
    log.Fatal(err)
}
defer img.Close()
img.SaveToFile("page.png")

// Масштаб (2×)
zoomed, _ := doc.RenderPageZoom(0, 2.0, 0)
defer zoomed.Close()

// Превью (ширина 200 px)
thumb, _ := doc.RenderThumbnail(0, 200, 0)
defer thumb.Close()

Поиск

// Поиск по всем страницам (без учёта регистра)
hits, _ := doc.SearchAll("configuration", false)
for _, r := range hits {
    fmt.Printf("страница %d: %q в (%.0f, %.0f)\n", r.Page, r.Text, r.X, r.Y)
}

// Поиск по одной странице
pageHits, _ := doc.SearchPage(0, "configuration", false)

Редактирование

Для работы с метаданными, страницами, аннотациями и формами используйте DocumentEditor:

editor, err := pdfoxide.OpenEditor("in.pdf")
if err != nil {
    log.Fatal(err)
}
defer editor.Close()

// Метаданные — по одному полю
_ = editor.SetTitle("Квартальный отчёт")
_ = editor.SetAuthor("Финансовый отдел")

// Или несколько полей сразу
_ = editor.ApplyMetadata(pdfoxide.Metadata{
    Title:   "Отчёт за Q1 2026",
    Author:  "Финансовый отдел",
    Subject: "Результаты",
})

// Операции со страницами
_ = editor.SetPageRotation(0, 90)
_ = editor.MovePage(2, 0)
_ = editor.DeletePage(5)

// Формы
_ = editor.SetFormFieldValue("employee.name", "Jane Doe")
_ = editor.FlattenForms()

// Сохранение
_ = editor.Save("out.pdf")
_ = editor.SaveEncrypted("secret.pdf", "user", "owner")

Штрихкоды

qr, _ := pdfoxide.GenerateQRCode("https://example.com", 0, 256)
defer qr.Close()
_ = os.WriteFile("qr.png", qr.PNGData(), 0644)

bc, _ := pdfoxide.GenerateBarcode("123456789", 0, 128)
defer bc.Close()

OCR

Чтобы включить OCR для отсканированных страниц, собирайте с фичей ocr:

go build -tags ocr ./...

ocr, _ := pdfoxide.NewOcrEngine()
defer ocr.Close()

if ocr.NeedsOcr(doc, 0) {
    text, _ := ocr.ExtractTextWithOcr(doc, 0)
    fmt.Println(text)
}

Полные рецепты — в руководстве по OCR.

Параллелизм

Чтение из PdfDocument безопасно между goroutine: несколько goroutine могут использовать один документ, чтобы извлекать страницы параллельно.

import "sync"

var wg sync.WaitGroup
count, _ := doc.PageCount()
out := make(chan string, count)

for i := 0; i < count; i++ {
    wg.Add(1)
    go func(page int) {
        defer wg.Done()
        text, err := doc.ExtractText(page)
        if err == nil {
            out <- text
        }
    }(i)
}

go func() { wg.Wait(); close(out) }()

for text := range out {
    _ = text
}

DocumentEditor сериализует записи внутри, но не прокачивайте независимые правки из нескольких goroutine через общий канал — собирайте изменения в одной goroutine. Шаблоны смотрите в руководстве по параллелизму.

Обработка ошибок

import "errors"

text, err := doc.ExtractText(0)
if err != nil {
    switch {
    case errors.Is(err, pdfoxide.ErrDocumentClosed):
        log.Print("документ закрыт")
    case errors.Is(err, pdfoxide.ErrInvalidPageIndex):
        log.Print("некорректный индекс страницы")
    case errors.Is(err, pdfoxide.ErrExtractionFailed):
        log.Print("не удалось извлечь текст")
    default:
        log.Printf("непредвиденно: %v", err)
    }
}

Доступные sentinel-ошибки:

ErrInvalidPath        ErrDocumentNotFound   ErrInvalidFormat
ErrExtractionFailed   ErrParseError         ErrInvalidPageIndex
ErrSearchFailed       ErrInternal           ErrDocumentClosed
ErrEditorClosed       ErrCreatorClosed      ErrIndexOutOfBounds
ErrEmptyContent

Получить числовой Code и Message можно через errors.As:

var e *pdfoxide.Error
if errors.As(err, &e) {
    fmt.Printf("code=%d message=%s\n", e.Code, e.Message)
}

Дальше